ga4gh / ga4gh/phenopacket-schema

Lack of examples for iterable fields

Open
#416 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
101
Forks
34
PR merge metrics
No merged PRs in 30d

Description

When creating a phenopacket, some fields must be provided as lists (for example, interpretations or biosamples), whereas others do not require this, such as individual. Without a complete example of how to create a phenopacket in Python, this behavior is difficult to infer, which complicates the initial implementation steps. Including clear, working examples would be extremely helpful.

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 does not name a file, test, or entry point. Start by locating the Python phenopacket construction documentation or examples, then compare iterable fields such as interpretations and biosamples with non-list fields such as individual. Done means a complete, working Python example clearly shows which fields require lists.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.