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

gtdbtk doc help not available unless GTDBTK_DATA_PATH is set #498

Closed
nick-youngblut opened this issue Mar 27, 2023 · 2 comments · Fixed by #504
Closed

gtdbtk doc help not available unless GTDBTK_DATA_PATH is set #498

nick-youngblut opened this issue Mar 27, 2023 · 2 comments · Fixed by #504
Labels
error Help required for a GTDB-Tk error. next version Upcoming feature/fix in staging branch.

Comments

@nick-youngblut
Copy link

This is a small, but annoying thing:

at least for GTDB-Tk v2.2.6, one cannot view the CLI help docs (e.g., gtdbtk classify_wf -h) without first setting a valid path to a GTDB-Tk database. Otherwise, instead of the help docs, the user gets:

================================================================================
                                     ERROR                                      
________________________________________________________________________________

          The 'GTDBTK_DATA_PATH' environment variable is not defined.           

            Please set this variable to your reference data package.            
           https://ecogenomics.github.io/GTDBTk/installing/index.html           
================================================================================

It would be helpful to evaluate GTDBTK_DATA_PATH after parsing the CLI args.

@nick-youngblut nick-youngblut added the error Help required for a GTDB-Tk error. label Mar 27, 2023
@pchaumeil
Copy link
Collaborator

Hello,
(This issue is similar to #491)

We will look to reimplement the GTDB-Tk logic so the basic options will not require to set GTDBTK_DATA_PATH.
This should be available in the next version.

@nick-youngblut
Copy link
Author

Sorry for the re-post of an existing issue. I had just looked through the open issues prior to creating this one

aaronmussig added a commit that referenced this issue Apr 3, 2023
…DBTK_DATA_PATH dynamically.

BREAKING CHANGE: If you import gtdbtk.config.config in a pipeline, this
will break your code.

Closes #491 #498
@aaronmussig aaronmussig added the next version Upcoming feature/fix in staging branch. label Apr 3, 2023
@aaronmussig aaronmussig linked a pull request Apr 3, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
error Help required for a GTDB-Tk error. next version Upcoming feature/fix in staging branch.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants