PEtab-dev / PEtab-dev/libpetab-python

writer functions do not perform sanity checks + use misleading options for writing tsv

Open
#26 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
18
Forks
9
PR merge metrics
No merged PRs in 30d

Description

When having dedicated writer functions such as petab.conditions.write_condition_df etc, I would actually expect that they perform some kind of sanity check on the output. Having pretty bare wrappers around pd.to_csv doesn't seem to helpful, especially since the writers use index=True, which is not consistent with the providede spec and, since the readers don't use index_col=0, leaves an Unnamed 0 column in the imported DataFrame.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the dedicated writer entry points mentioned, such as petab.conditions.write_condition_df, and trace their pd.to_csv options alongside the corresponding readers. Compare the output with the PEtab specification and verify that imported DataFrames do not gain an Unnamed 0 column. Done means the writers perform the required sanity checks and use consistent TSV-writing options.

Written by the indexing model from the issue text.

Assessment

Tech stack
pandas, python
Domain
data
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.