logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

efetch, esummary - retrieve results from an NCBI Entrez search

Description

efetch and esummary retrieve results from either an Entrez Direct pipeline or an  immediate  lookup  (via
       -db and -id or -input).  esummary is equivalent to efetch-formatdocsum.

       efetch  is  also  the  name  of  an  AceDB tool for consulting local sequence databases.  To resolve this
       ambiguity, Debian systems with  both  AceDB  tools  and  Entrez  Direct  installed  arrange  for  AceDB's
       executable to have the name efetch.acedb(1) and for efetch to be a wrapper script that examines its usage
       and proceeds to run whichever of efetch.acedb(1) or efetch.ncbi looks like a better fit.

Name

       efetch, esummary - retrieve results from an NCBI Entrez search

Options

FormatSelection-formatfmt
              Format of record or report.  (See -help output for examples.)

       -modemodetext, xml, asn.1, or json.

       -stylestylemaster or conwithfeat.

   DirectRecordSelection-dbname
              Entrez database name for immediate lookups.

       -idID Unique identifier or accession for immediate lookups.

       -inputfilename
              Read identifer(s) from file instead of standard input.

   SequenceRange-seq_startN
              First sequence position to retrieve (1-based).

       -seq_stopN
              Last sequence position to retrieve (1-based).

       -strandN
              Strand of DNA to retrieve: 1 for forward (plus), 2 for reverse complement (minus).

       -forward
              Shortcut for -strand1.

       -revcomp
              Shortcut for -strand2.

   GeneRange-chr_startN
              First sequence position to retrieve (0-based).

       -chr_stopN
              Last sequence position to retrieve (0-based).

   SequenceFlags-complexityN
              How much context to fetch:
              0      default
              1      Bioseq
              3      Nuc-prot set

       -extendN
              Extend sequence retrieval by N residues in both directions.

       -extrafeatN
              Bit flag specifying extra features.

       -showgaps
              Propagate component gaps.

   SubsetRetrieval-startN
              First record to fetch.

       -stopN
              Last record to fetch.

   Miscellaneous-raw   Skip database-specific XML modifications.

       -express
              Direct sequence retrieval in groups of five.

       -immediate
              Express mode on a single record at a time.

       -json  Convert adjusted XML output to JSON.

       -help  Print  usage information, complete with examples of notable -db/-format/-mode combinations (in the
              case of efetch) and of supplying accessions in the -id field (in the case of esummary).

See Also

combine-uid-lists(1),  difference-uid-lists(1),  ds2pme(1),  efetch.acedb(1),   esample(1),   esearch(1),
       exclude-uid-lists(1),    hgvs2spdi(1),    intersect-uid-lists(1),   nquire(1),   pma2pme(1),   rchive(1),
       transmute(1), xml2fsa(1), xml2tbl(1), xtract(1).

NCBI                                               2023-02-12                                          EFETCH(1)

Synopsis

efetch   [-help]   [-formatfmt]   [-modemode]   [-stylestyle]  [-dbname]  [-idID]  [-inputfilename]
       [-seq_startN]   [-seq_stopN]   [-strandN]   [-forward]   [-revcomp]    [-chr_startN]    [-chr_stopN]
       [-complexityN]   [-extendN]   [-extrafeatN]   [-showgaps]   [-startN]   [-stopN]  [-raw]  [-express]
       [-immediate] [-json]

       esummary [-help] [-modemode] [-dbname] [-idID] [-inputfilename] [-raw]

See Also