-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
977b1c3
commit 225107a
Showing
2 changed files
with
44 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,40 @@ | ||
# unite-train | ||
|
||
A pipeline to build [Qiime2](https://qiime2.org/) taxonomy [classifiers](https://docs.qiime2.org/2021.11/data-resources/) for the [UNITE database](https://unite.ut.ee/repository.php). | ||
|
||
### [Download a pre-trained classifier here! 🎁](https://github.com/colinbrislawn/unite-train/releases) | ||
|
||
[](https://github.com/colinbrislawn/unite-train/issues) | ||
[](https://github.com/colinbrislawn/unite-train/releases) | ||
[](https://github.com/colinbrislawn/unite-train/releases) | ||
|
||
# Running Snakemake workflow | ||
|
||
Set up: | ||
- Install [mamba](https://mamba.readthedocs.io/en/latest/installation.html) and configure [Bioconda](https://bioconda.github.io/). Then install [Snakemake](https://snakemake.readthedocs.io/en/stable/getting_started/installation.html) and activate the Snakemake environment. | ||
|
||
Run: | ||
```bash | ||
snakemake --cores 8 --use-conda --conda-create-envs-only | ||
# Connect to a worker node, if needed, then | ||
snakemake --cores 8 --use-conda --resources mem_mb=9000 | ||
# This takes about 11 hours on my machine | ||
``` | ||
|
||
Reports: | ||
```bash | ||
snakemake --report results/report.html | ||
snakemake --forceall --dag --dryrun | dot -Tpdf > results/dag.pdf | ||
``` | ||
# unite-train | ||
|
||
A pipeline to build [Qiime2](https://qiime2.org/) taxonomy [classifiers](https://docs.qiime2.org/2021.11/data-resources/) for the [UNITE database](https://unite.ut.ee/repository.php). | ||
|
||
## [Download a pre-trained classifier here! 🎁](https://github.com/colinbrislawn/unite-train/releases) | ||
|
||
[](https://github.com/colinbrislawn/unite-train/issues) | ||
[](https://github.com/colinbrislawn/unite-train/releases) | ||
[](https://github.com/colinbrislawn/unite-train/releases) | ||
|
||
--- | ||
|
||
## Running Snakemake workflow | ||
|
||
Set up: | ||
|
||
- Install [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge) and configure [Bioconda](https://bioconda.github.io/). | ||
- Install the version of [Qiime2](https://docs.qiime2.org/) you want using the recomended environment name. | ||
(For a faster install, you can replace `conda` with `mamba`.) | ||
- Install [Snakemake](https://snakemake.readthedocs.io/en/stable/getting_started/installation.html) into an environment, then activate that environment. | ||
|
||
Configure: | ||
|
||
- Open up `config/config.yaml` and configure it to your liking. | ||
(For example, you may need to update the name of your Qiime2 environment.) | ||
|
||
Run: | ||
|
||
```bash | ||
snakemake --cores 8 --use-conda --resources mem_mb=10000 | ||
``` | ||
|
||
This takes about 15 hours on my machine | ||
|
||
Reports: | ||
|
||
```bash | ||
snakemake --report results/report.html | ||
snakemake --forceall --dag --dryrun | dot -Tpdf > results/dag.pdf | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters