summaryrefslogtreecommitdiff
path: root/doc/man/idfetch.1
blob: 188deff1a8ce1eba477cb1536f9660fb2f5e4aa0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
.TH IDFETCH 1 2005-06-24 NCBI "NCBI Tools User's Manual"
.SH NAME
idfetch \- retrieve biological data from the NCBI ID1 server
.SH SYNOPSIS
.B idfetch
[\|\fB\-\fP\|]
[\|\fB\-F\fP\ \fIstr\fP\|]
[\|\fB\-G\fP\ \fIfilename\fP\|]
[\|\fB\-Q\fP\ \fIfilename\fP\|]
[\|\fB\-c\fP\ \fIN\fP\|]
[\|\fB\-d\fP\ \fIstr\fP\|]
[\|\fB\-e\fP\ \fIN\fP\|]
[\|\fB\-f\fP\ \fIstr\fP\|]
[\|\fB\-g\fP\ \fIN\fP\|]
[\|\fB\-i\fP\ \fIN\fP\|]
[\|\fB\-l\fP\ \fIfilename\fP\|]
[\|\fB\-n\fP\|]
[\|\fB\-o\fP\ \fIfilename\fP\|]
[\|\fB\-q\fP\ \fIstr\fP\|]
[\|\fB\-s\fP\ \fIstr\fP\|]
[\|\fB\-t\fP\ \fIN\fP\|]
.SH DESCRIPTION
\fBidfetch\fP is a client for NCBI's ID1 server, which contains a
large database of annotated biological sequences.
.SH OPTIONS
A summary of options is included below.
.TP
\fB\-\fP
Print usage message
.TP
\fB\-F\fP\ \fIstr\fP
Add the specified feature types (comma-delimited); allowed values are
CDD, SNP, SNP_graph, MGC, HPRD, and STS.
.TP
\fB\-G\fP\ \fIfilename\fP
File with list of GIs, (versioned) accessions, FASTA SeqID's to dump
.TP
\fB\-Q\fP\ \fIfilename\fP
Generate GI list by Entrez query in \fIfilename\fP; requires \fB\-dn\fP
or \fB\-dp\fP.
.TP
\fB\-c\fP\ \fIN\fP
Max complexity:
.RS
.PD 0
.IP 0
get the whole blob (default)
.IP 1
get the bioseq of interest
.IP 2
get the minimal bioseq-set containing the bioseq of interest
.IP 3
get the minimal nuc-prot containing the bioseq of interest
.IP 4
get the minimal pub-set containing the bioseq of interest
.PD
.RE
.TP
\fB\-d\fP\ \fIstr\fP
Database to use (with \fB\-q\fP, can be either \fBn\fP for nucleotides
or \fBp\fP for proteins).
.TP
\fB\-e\fP\ \fIN\fP
Entity number (retrieval number) to dump
.TP
\fB\-f\fP\ \fIstr\fP
Flattened SeqId.  Possible formats:
.br
\fItype\fP([\fIname\fP][,[\fIaccession\fP][,[\fIrelease\fP][,\fIversion\fP]]])
as '5(HUMHBB)'
.br
\fItype\fP=\fIaccession\fP
.br
\fItype\fP:\fInumber\fP
.br
(\fItype\fP is a number indicating the ASN.1 Seq-id subtype.)
.TP
\fB\-g\fP\ \fIN\fP
GI id for single Entity to dump
.TP
\fB\-i\fP\ \fIN\fP
Type of lookup:
.RS
.PD 0
.IP 0
get Seq-entry (default)
.IP 1
get GI state (output to stderr)
.IP 2
get SeqIds
.IP 3
get GI history (sequence change only)
.IP 4
get revision history (any change to ASN.1)
.PD
.RE
.TP
\fB\-l\fP\ \fIfilename\fP
Log file
.TP
\fB\-n\fP
Output only the list of GIs (with \fB\-q\fP and \fB\-Q\fP).
.TP
\fB\-o\fP\ \fIfilename\fP
Filename for output (default = \fBstdout\fP)
.TP
\fB\-q\fP\ \fIstr\fP
Generate gi list by Entrez query.  Requires \fB\-dn\fP or \fB\-dp\fP.
.TP
\fB\-s\fP\ \fIstr\fP
FASTA style SeqId ENCLOSED IN QUOTES.  Formats:
.br
.BI lcl| "int or str"
.br
.BI bbs| int
.br
.BI bbm| int
.br
.BI gb| acc | loc
.br
.BI emb| acc | loc
.br
.BI pir| acc | name
.br
.BI sp| acc | name
.br
.BI pat| country | patent | seq
.br
.BI gi| int
.br
.BI dbj| acc | loc
.br
.BI prf| acc | name
.br
.BI pdb| entry | chain
.TP
\fB\-t\fP\ \fIN\fP
Output type:
.RS
.PD 0
.IP 1
text ASN.1 (default)
.IP 2
binary ASN.1
.IP 3
GenBank (Seq-entry only)
.IP 4
GenPept (Seq-entry only)
.IP 5
FASTA (table for history)
.IP 6
quality scores (Seq-entry only)
.IP 7
Entrez DocSums
.PD
.RE
.SH AUTHOR
The National Center for Biotechnology Information.