Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ksilnoaa committed Aug 15, 2023
1 parent 7204c53 commit 89e62dd
Showing 1 changed file with 19 additions and 13 deletions.
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,20 +68,26 @@ Before you download the Tourmaline commands and directory structure from GitHub,

#### Option 1: Native installation

To run Tourmaline natively on a Mac (Intel) or Linux system, start with a Conda installation of QIIME 2 (for Linux, change "osx" to "linux"):
To run Tourmaline natively on a Mac (Intel) or Linux system, start with a Conda installation of Snakemake v7.30.1. We recommend using [Miniconda with a python >= 3.8](https://docs.conda.io/en/latest/miniconda.html):

```bash
wget https://data.qiime2.org/distro/core/qiime2-2023.2-py38-osx-conda.yml
# make sure you are using the most updated conda
conda update conda
conda env create -n qiime2-2023.2 --file qiime2-2023.2-py38-osx-conda.yml
conda install -c conda-forge -c bioconda snakemake=7.30.1
```

Then install QIIME 2 with conda (**for Linux, change "osx" to "linux"**):

```bash
wget https://data.qiime2.org/distro/core/qiime2-2023.5-py38-osx-conda.yml
conda env create -n qiime2-2023.5 --file qiime2-2023.5-py38-osx-conda.yml
```

Activate the environment and install the other Conda- or PIP-installable dependencies:
Activate the qiime2-2023.5 environment and install the other Conda- or PIP-installable dependencies:

```
conda activate qiime2-2023.2
conda install -c conda-forge -c bioconda snakemake biopython muscle clustalo tabulate
conda install -c conda-forge -c bioconda biopython muscle clustalo tabulate
conda install -c conda-forge deicode
pip install empress
qiime dev refresh-cache
Expand Down Expand Up @@ -193,12 +199,12 @@ Now edit, replace, or store the required input files as described here:

Shown here is the DADA2 paired-end workflow. See the Wiki's [Run](https://github.com/aomlomics/tourmaline/wiki/4-Run) page for complete instructions on all steps, denoising methods, and filtering modes.

Note that any of the commands below can be run with various options, including `--printshellcmds` to see the shell commands being executed and `--dryrun` to display which rules would be run but not execute them. To generate a graph of the rules that will be run from any Snakemake command, see the section "Directed acyclic graph (DAG)" on the [Run](https://github.com/aomlomics/tourmaline/wiki/4-Run) page.
Note that any of the commands below can be run with various options, including `--printshellcmds` to see the shell commands being executed and `--dryrun` to display which rules would be run but not execute them. To generate a graph of the rules that will be run from any Snakemake command, see the section "Directed acyclic graph (DAG)" on the [Run](https://github.com/aomlomics/tourmaline/wiki/4-Run) page. **Always include the --use-conda option.**

From the `tourmaline` directory (which you may rename), run Snakemake with the *denoise* rule as the target, changing the number of cores to match your machine:

```bash
snakemake dada2_pe_denoise --cores 4
snakemake --use-conda dada2_pe_denoise --cores 4
```

Pausing after the *denoise* step allows you to make changes before proceeding:
Expand All @@ -212,19 +218,19 @@ Pausing after the *denoise* step allows you to make changes before proceeding:
Continue the workflow without filtering (for now). If you are satisfied with your parameters and files, run the *taxonomy* rule (for unfiltered data):

```bash
snakemake dada2_pe_taxonomy_unfiltered --cores 4
snakemake --use-conda dada2_pe_taxonomy_unfiltered --cores 4
```

Next, run the *diversity* rule (for unfiltered data):

```bash
snakemake dada2_pe_diversity_unfiltered --cores 4
snakemake --use-conda dada2_pe_diversity_unfiltered --cores 4
```

Finally, run the *report* rule (for unfiltered data):

```bash
snakemake dada2_pe_report_unfiltered --cores 4
snakemake --use-conda dada2_pe_report_unfiltered --cores 4
```

#### Filtered mode
Expand All @@ -239,19 +245,19 @@ After viewing the *unfiltered* results—the taxonomy summary and taxa barplot,
Now we are ready to filter the representative sequences and feature table, generate new summaries, and generate a new taxonomy bar plot, by running the *taxonomy* rule (for filtered data):

```bash
snakemake dada2_pe_taxonomy_filtered --cores 4
snakemake --use-conda dada2_pe_taxonomy_filtered --cores 4
```

Next, run the *diversity* rule (for filtered data):

```bash
snakemake dada2_pe_diversity_filtered --cores 4
snakemake --use-conda dada2_pe_diversity_filtered --cores 4
```

Finally, run the *report* rule (for filtered data):

```bash
snakemake dada2_pe_report_filtered --cores 1
snakemake --use-conda dada2_pe_report_filtered --cores 1
```

### View output
Expand Down

0 comments on commit 89e62dd

Please sign in to comment.