Skip to content

Commit 60333e8

Browse files
committed
added documentation for all rules
1 parent 983d9e2 commit 60333e8

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

workflow/documentation.md

+19
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,25 @@ is run in parallel using `scattergather` and is implemented in the
3838
needs to know ahead of time how many families to expect, which needs to be
3939
specified in the configuration file.
4040

41+
---
42+
### `makeblastdb`
43+
44+
Creates a BLAST database from all family FASTA files from the `family_fasta`
45+
rule, retaining the sequences that have an OpenToL ID and reformatting them
46+
so that the definition line only has the process ID of the sequence. The
47+
script is implemented in [makeblastdb.sh](scripts/makeblastdb.sh), which
48+
uses the `makeblastdb` command from the BLAST+ suite to create the database.
49+
50+
---
51+
### `get_outgroups`
52+
53+
Fetches outgroup sequences from the BLAST database. This is done by running
54+
a BLAST search with the focal ingroup sequences (i.e. a family fasta file)
55+
against the BLAST database, and then selecting the most common hits across the
56+
ingroup sequences. The script is implemented in
57+
[get_outgroups.sh](scripts/get_outgroups.sh) and is parallelized using
58+
`scattergather`.
59+
4160
---
4261
### `family_constraint`
4362

0 commit comments

Comments
 (0)