genome

Download a virus genome dataset by accession or taxon

Name

datasets download virus genome - Download a virus genome dataset by accession or taxon

Synopsis

datasets download virus genome [command] [flags]

Description

    Download a virus genome data package by GenBank or RefSeq nucleotide accession. Virus genome data packages include genome,
	transcript and protein sequences, annotation and one or more data reports. Data packages are downloaded as a zip archive.

	The default virus genome data package includes the following files:
      * genomic.fna (genomic sequences)
      * data_report.jsonl (data report with virus genome metadata)
      * dataset_catalog.json (a list of files and file types included in the data package)

Examples

  datasets download virus genome taxon sars-cov-2 --host dog --include protein
  datasets download virus genome taxon coronaviridae --host "manis javanica"

Options

      --annotated                 Limit to annotated genomes
      --api-key string            Specify an NCBI API key
      --complete-only             Limit to complete genomes
      --debug                     Emit debugging info
      --fast-zip-validation       Skip zip checksum validation after download
      --filename string           Specify a custom file name for the downloaded data package (default "ncbi_dataset.zip")
      --geo-location string       Limit to genomes isolated from a specified geographic location (continent or country)
      --help                      Print detailed help about a datasets command
      --host string               Limit to virus genomes isolated from a specified host species
      --include string(,string)   Specify virus genome sequence types to download
                                    * genome:     genomic sequences
                                    * cds:        nucleotide coding sequences
                                    * protein:    amino acid sequences
                                    * annotation: annotation report
                                    * biosample:  biosample report
                                    * none:       no sequence data, only primary data report
                                       (default [genome])
      --lineage string            Limit results by Pango lineage (only SARS-CoV-2)
      --no-progressbar            Hide progress bar
      --refseq                    Limit to RefSeq genomes
      --released-after string     Limit to genomes released on or after a specified date (free format, ISO 8601 YYYY-MM-DD recommended)
      --updated-after string      Limit to genomes updated on or after a specified date (free format, ISO 8601 YYYY-MM-DD recommended)
      --usa-state string          Limit to genomes isolated from a specified U.S. state (two-letter abbreviation)
      --version                   Print version of datasets

Commands


accession

Download a virus genome data package by accession.

taxon

Download a virus genome data package by taxon (NCBI Taxonomy ID, scientific or common name for any virus at any tax rank)

Generated November 25, 2024