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

Specify in documentation that the --genes parameter requires proteins as input. #571

Closed
LeeBergstrand opened this issue Feb 22, 2024 · 0 comments
Labels
next version Upcoming feature/fix in staging branch.

Comments

@LeeBergstrand
Copy link

Problem Description

Currently, the CLI and the documentation state the following for the --genes parameter:

indicates input files contain called genes (skip gene calling).Warning: This flag will skip the ANI comparison steps (ani_screen and classification).

I wasn't sure if I should provide the CDS gene predictions in nucleotide format or the protein translations of those CDS.

When I fed the pipeline my cds.fna files, it failed as expected. However, I had to dig into GitHub pull requests and source code to determine that the --genes parameter requires proteins as input.

Proposed Solution

Specify in the documentation that the pipeline expects proteins as input when the --genes flag is specified.

indicates input files contain predicted proteins (skip gene calling). Warning: This flag will skip the ANI comparison steps (ani_screen and classification).
pchaumeil added a commit that referenced this issue Apr 10, 2024
Description of --genes flag is more explicit and mentions input as predicted proteins
@pchaumeil pchaumeil added the next version Upcoming feature/fix in staging branch. label Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
next version Upcoming feature/fix in staging branch.
Projects
None yet
Development

No branches or pull requests

2 participants