ncbi / ncbi/datasets

Fetch genes by assembly ID OR fetch genome annotation report using the CLI

Open
#600 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Jupyter Notebook
Stars
559
Forks
70
Avg merge
1m
Merged PRs (30d)
2

Description

Is your feature request related to a problem? Please describe.

Use case: I maintain an archive of genomes of interest, which includes sequence data from the NCBI FTP archives, assembly metadata, and gene/protein annotations and metadata. I currently use the following REST API endpoints:

I can get the dataset report using the datasets CLI and would like to be able to do the same for the annotation report.

Describe the solution you'd like

a CLI equivalent of the annotation_report endpoint that allows users to supply a list of NCBI assembly accessions to retrieve annotation data for those assemblies. Alternatively, being able to retrieve gene reports by assembly accession (retrieval by taxon already exists) would be great.

Thank you

Thank you for the datasets command line tool - it is extremely useful and much quicker than using the API!

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

Start by inspecting the existing datasets CLI command that retrieves the dataset report and compare its request and response handling with the annotation_report endpoint. Done means a CLI path accepts one or more assembly accessions and retrieves annotation data, or implements the requested assembly-based gene report.

Written by the indexing model from the issue text.

Assessment

Domain
api, cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.