Skip to content

Commit c8465ff

Browse files
committed
Add missing features.
1 parent 764ea70 commit c8465ff

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

website/docs/cli-usage/align-filter.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,12 @@ segul align filter --dir alignments/ --input-format nexus --percent-inf 0.8
7070

7171
# Proportion of missing data
7272
segul align filter --dir alignments/ --missing-data 0.3
73+
74+
# Minimum taxon counts
75+
segul align filter --dir alignments/ --min-ntax 100
76+
77+
# Taxon ID
78+
segul align filter --dir alignments/ --taxon-id path/to/taxon_ids.txt
7379
```
7480

7581
To check the available filtering options and other command arguments, use the `--help` option:
@@ -203,6 +209,38 @@ SEGUL will will copy the matching alignments to the output directory. To filter
203209
segul align filter --dir alignments/ --missing-data 0.3
204210
```
205211

212+
## Filtering based on minimum taxon counts
213+
214+
To filter alignments based on the minimum number of taxa present in each alignment, use the `--min-ntax` option. For example, to filter alignments with at least 100 taxa, use the command below:
215+
216+
```Bash
217+
segul align filter --dir alignments/ --min-ntax 100
218+
```
219+
220+
:::info
221+
Available in SEGUL v0.23.0 and later versions.
222+
:::
223+
224+
## Filtering based on taxon ID
225+
226+
The taxon ID is the same as your sequence ID. To use this feature, you need to provide a text file containing a list of taxon IDs (one taxon ID per line). SEGUL will filter alignments that contain the taxon IDs specified in the file. For example, if you have a file named `taxon_ids.txt` with the following content:
227+
228+
```Text
229+
taxon_1
230+
taxon_2
231+
taxon_3
232+
```
233+
234+
You can use the following command to filter alignments in the `alignments/` directory that contain these taxon IDs:
235+
236+
```Bash
237+
segul align filter --dir alignments/ --taxon-id path/to/taxon_ids.txt
238+
```
239+
240+
:::info
241+
Available in SEGUL v0.23.0 and later versions.
242+
:::
243+
206244
## Specifying output directories
207245

208246
By default, SEGUL output directories for filtering are based on the input directory names suffixed with filtering values. The format is as follows:

0 commit comments

Comments
 (0)