gene

Print a summary of a gene dataset

Name

datasets summary gene - Print a summary of a gene dataset

Synopsis

datasets summary gene [flags]

Description

Print a data report containing gene metadata. The data report is returned in JSON format.

Examples

  datasets summary gene gene-id 672
  datasets summary gene symbol brca1 --taxon "mus musculus"
  datasets summary gene accession NP_000483.3

Options

      --api-key string   Specify an NCBI API key
      --as-json-lines    Stream results as newline delimited JSON-Lines
      --debug            Emit debugging info
      --help             Print detailed help about a datasets command
      --limit string     Limit the number of gene summaries returned
                           * all:      returns all matching gene summaries
                           * a number: returns the specified number of matching gene summaries
                              (default "all")
      --report string    Choose the output type:
                           * gene:     Retrieve the primary gene report
                           * product:  Retrieve product data report
                           * ids_only: Only retrieve gene-ids
                              (default "complete")
      --version          Print version of datasets

Commands


gene-id

Print a data report containing gene metadata by NCBI Gene ID

symbol

Print a data report containing gene metadata by gene symbol

accession

Print a data report containing gene metadata by RefSeq nucleotide or protein accession

taxon

Print a data report containing gene metadata by taxon (NCBI Taxonomy ID, scientific or common name for a species)

Generated May 21, 2024