PEtab-dev / PEtab-dev/libpetab-python

Validator: Add option to warn about unused / non-standard columns

Open
#128 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Might be helpful to spot typos in column names. Those aren't easy to catch, as some columns are optional and additional columns are allowed in most files. Could also implement something smarter, e.g. flagging column IDs with a small Levenshtein distance from standard columns.

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

The issue names no files or tests. Start by locating the validator and the definitions of standard and optional columns, then determine how warnings should coexist with allowed extra columns. Done should mean the validator can report unused or non-standard columns, with any Levenshtein-based suggestions explicitly defined and tested.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.