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

doc: ncbi datasets #211

Merged
merged 1 commit into from
Oct 25, 2023
Merged

doc: ncbi datasets #211

merged 1 commit into from
Oct 25, 2023

Conversation

j23414
Copy link
Contributor

@j23414 j23414 commented Oct 16, 2023

Description of proposed changes

Since the transition from NCBI Virus to NCBI datasets, revised the documentation to reflect changes in how metadata and sequences are fetched from NCBI.

Feel free to propose alternative wording or descriptions.

Related issue(s)

Checklist

  • Checks pass

@j23414 j23414 requested review from jameshadfield and a team October 16, 2023 18:36
Copy link
Contributor

@joverlee521 joverlee521 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating the docs here! (I should have done this as part of #179.)

I recommend adding a "Software requirements" section (similar to the phylogenetic/README) that points to the centralized Nextstrain installation docs instead of adding detailed docs on the NCBI Datasets here.

NCBI Datasets CLI is included in the docker/conda runtimes and would not need to be installed separately. Once we add ncbi-datasets-cli to our ambient installation instructions, the centralized installation docs should cover everything. Then we wouldn't need to maintain separate docs within each pathogen repo that uses NCBI Datasets.

@j23414
Copy link
Contributor Author

j23414 commented Oct 23, 2023

Thanks @joverlee521! Updated centralized Nextstrain installation docs in nextstrain/docs.nextstrain.org#172 and added a software requirments section. This PR is ready for review.

@j23414 j23414 force-pushed the doc_ncbi_datasets branch from 535b0d1 to 338719f Compare October 25, 2023 17:31
@j23414 j23414 merged commit c310037 into master Oct 25, 2023
@j23414 j23414 deleted the doc_ncbi_datasets branch October 25, 2023 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants