Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add optional CLI parameter for organism to main app #24

Closed
uniqueg opened this issue Oct 10, 2020 · 1 comment · Fixed by #38
Closed

Add optional CLI parameter for organism to main app #24

uniqueg opened this issue Oct 10, 2020 · 1 comment · Fixed by #38
Assignees
Labels
hackathon Programming for Life Sciences 2020 hackathon read orientation Infer orientation of reads

Comments

@uniqueg
Copy link
Member

uniqueg commented Oct 10, 2020

In order to select the transcripts that the reads should be mapped to in later steps (see #26 and #27) of the read orientation inference process, the organism that the sample was derived from needs to be known. As we currently do not have a functionality to infer the organism from the data (it has been started and is almost ready, but has not been merged), we need to be able to pass that information when we are executing the read orientation inference (#23).

Add a command-line interface (CLI) parameter --organism that either takes an organism short name (a string) or a taxon ID (an integer). Have a look at data/transcripts.fasta to see how these look like (4th and 5th fields of identifier lines, respectively). Ensure that passing --organism when calling htsinfer.py is optional. Validate that the input is either of type str or of type int. Don't forget to document the new CLI parameter in the repo's README.md.

@uniqueg uniqueg added hackathon Programming for Life Sciences 2020 hackathon read orientation Infer orientation of reads labels Oct 10, 2020
@uniqueg uniqueg changed the title Add an optional CLI parameter "--organism" to the main app Add optional CLI parameter for organism to main app Oct 10, 2020
@uniqueg
Copy link
Member Author

uniqueg commented Oct 14, 2020

When you set an optional CLI parameter, you will need to set some default (in case it is not provided). For now, a reasonable default could be hsapiens. Later on, once the organism inference functionality is in, we would probably set it to None so that it would be inferred by that functionality by default, and that inference would be skipped if the user provides an organism explicitly.

@uniqueg uniqueg self-assigned this Oct 20, 2020
Infer read orientation automation moved this from To do to Done Oct 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hackathon Programming for Life Sciences 2020 hackathon read orientation Infer orientation of reads
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

1 participant