Skip to content

Commit

Permalink
Update README and avamb.snake.conda.smk
Browse files Browse the repository at this point in the history
  • Loading branch information
Paupiera committed Jun 26, 2023
1 parent ea47871 commit 72978b3
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
2 changes: 1 addition & 1 deletion workflow_avamb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ In short it will:
The nice thing about using snakemake for this is that it will keep track of which jobs have finished and it allows the workflow to be run on different hardware such as a laptop, a linux workstation and a HPC facility (currently with qsub). Keep in mind that there are three different paths, (named directed acyclic graphs in snakemake), that can be executed by snakemake depending on the outputs generated during the workflow and complicating a bit the interpretation of the snakemake file. That's why we added some comments for each rule briefily explaining their purpose. Feel free to reach us if you encounter any problems.

## Installation
To run the workflow first install a Python3 version of [Miniconda](https://docs.conda.io/en/latest/miniconda.html) and [mamba](https://mamba.readthedocs.io/en/latest/installation.html#fresh-install). Avamb uses CheckM2 to score the bins, unfortunately, due to some dependencies conflicts, CheckM2 can not be installed in the same environment than vamb, therefore a specific environment should be created for CheckM2 and for Avamb:
To run the workflow first install a Python3 version of [Miniconda](https://docs.conda.io/en/latest/miniconda.html), [mamba](https://mamba.readthedocs.io/en/latest/installation.html#fresh-install) and [snakemake](https://snakemake.readthedocs.io/en/stable/getting_started/installation.html). Avamb uses CheckM2 to score the bins, unfortunately, due to some dependencies conflicts, CheckM2 can not be installed in the same environment than vamb, therefore a specific environment should be created for CheckM2 and for Avamb:

```
# Install Avamb in avamb environment
Expand Down
5 changes: 4 additions & 1 deletion workflow_avamb/avamb.snake.conda.smk
Original file line number Diff line number Diff line change
Expand Up @@ -415,7 +415,10 @@ rule run_checkm2_per_sample_all_bins:
conda:
"checkm2"
shell:
"checkm2 predict --threads {threads} --input {OUTDIR}/avamb/bins/{wildcards.sample}/*.fna --output-directory {OUTDIR}/tmp/checkm2_all/{wildcards.sample} > {output.out_log_file}"
"""
checkm2 predict --threads {threads} --input {OUTDIR}/avamb/bins/{wildcards.sample}/*.fna --output-directory {OUTDIR}/tmp/checkm2_all/{wildcards.sample}
touch {output.out_log_file}
"""

# this rule will be executed when all CheckM2 runs per sample finish, so it can move to the next step
rule cat_checkm2_all:
Expand Down

0 comments on commit 72978b3

Please sign in to comment.