Skip to content

Commit 3769f85

Browse files
Add lab_passaged and annotated filters to documentation
1 parent 71ca049 commit 3769f85

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/src/en/virus.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,16 @@ _Host filters_
2323
`--host`
2424
Filter by host organism name or NCBI Taxonomy ID (e.g., 'human', 'Aedes aegypti', `1335626`).
2525

26+
`--lab_passaged`
27+
'true' or 'false'. Filter for or against lab-passaged samples.
28+
Command line: `--lab_passaged true` to fetch only lab-passaged samples, or `--lab_passaged false` to exclude them.
29+
Python: `lab_passaged=True` or `lab_passaged=False` (`lab_passaged=None` for no filter).
30+
2631
_Sequence & Gene filters_
2732

2833
`--nuc_completeness`
2934
Filter by nucleotide completeness. One of: 'complete' or 'partial'.
30-
Set to 'complete' to only return full-length viral genomes; set to 'partial' to only return sequences that are NOT full-length viral genomes.
35+
Set to 'complete' to only return nucleotide sequences marked as complete; set to 'partial' to only return sequences that are marked as partial.
3136

3237
`--min_seq_length`
3338
Filter by minimum sequence length.
@@ -60,6 +65,11 @@ Filter by maximum number of ambiguous nucleotide characters (N's).
6065
Filter for sequences containing specific proteins or genes (e.g., 'spike', 'ORF1ab'). Can be a single protein name or a list of protein names.
6166
Python: `has_proteins="spike"` or `has_proteins=["spike", "ORF1ab"]`
6267

68+
`--annotated`
69+
'true' or 'false'. Filter for sequences that have been annotated with gene/protein information.
70+
Command line: `--annotated true` to fetch only that have been annotated with gene/protein information, or `--annotated false` to exclude them.
71+
Python: `annotated=True` or `annotated=False` (`annotated=None` for no filter).
72+
6373
_Date filters_
6474

6575
`--min_collection_date`
@@ -115,16 +125,6 @@ Use NCBI's optimized cached data packages for an Alphainfluenza (Influenza A vir
115125
`-g` `--genbank_metadata`
116126
Fetch and save additional detailed metadata from GenBank, including collection dates, host details, and publication references, in a separate `{virus}_genbank_metadata.csv` file (plus full XML/CSV dumps).
117127

118-
`--annotated`
119-
Filter for sequences that have been annotated with gene/protein information.
120-
Command line: `--annotated true` or `--annotated false`.
121-
Python: `annotated=True` or `annotated=False`.
122-
123-
`--lab_passaged`
124-
Filter for or against lab-passaged samples.
125-
Command line: `--lab_passaged true` to fetch only lab-passaged samples, or `--lab_passaged false` to exclude them.
126-
Python: `lab_passaged=True` or `lab_passaged=False`.
127-
128128
`--proteins_complete`
129129
Flag to only include sequences where all annotated proteins are complete.
130130

0 commit comments

Comments
 (0)