Skip to content

Commit b1d0d34

Browse files
committed
fix: added missing dag.
1 parent a4a147a commit b1d0d34

3 files changed

Lines changed: 161 additions & 31 deletions

File tree

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ If you use this workflow in a paper, don't forget to give credits to the authors
2626

2727
_Workflow overview:_
2828

29-
<!-- include overview-->
3029
<img src="resources/images/dag.svg" align="center" />
3130

3231
## Workflow overview
@@ -72,14 +71,14 @@ conda activate snakemake-assembly-postprocessing
7271
To run the workflow from command line, change the working directory.
7372

7473
```bash
75-
cd path/to/snakemake-simple-mapping
74+
cd snakemake-assembly-postprocessing
7675
```
7776

7877
Adjust options in the default config file `config/config.yml`.
7978
Before running the complete workflow, you can perform a dry run using:
8079

8180
```bash
82-
snakemake --dry-run
81+
snakemake --cores 1 --dry-run
8382
```
8483

8584
To run the workflow with test files using **conda**:

config/README.md

Lines changed: 2 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,34 +10,6 @@ A Snakemake workflow for the post-processing of microbial genome assemblies.
1010
3. Create a QC report for the assemblies using [Quast](https://github.com/ablab/quast)
1111
4. Create a pangenome analysis (orthologs/homologs) using [Panaroo](https://gthlab.au/panaroo/)
1212

13-
## Installation
14-
15-
**Step 1: Clone this repository**
16-
17-
```bash
18-
git clone https://github.com/MPUSP/snakemake-assembly-postprocessing.git
19-
cd snakemake-assembly-postprocessing
20-
```
21-
22-
**Step 2: Install dependencies**
23-
24-
It is recommended to install snakemake and run the workflow with `conda` or `mamba`. [Miniforge](https://conda-forge.org/download/) is the preferred conda-forge installer and includes `conda`, `mamba` and their dependencies.
25-
26-
**Step 3: Create snakemake environment**
27-
28-
This step creates a new conda environment called `snakemake-assembly-postprocessing`.
29-
30-
```bash
31-
mamba create -c conda-forge -c bioconda -n snakemake-assembly-postprocessing snakemake pandas
32-
conda activate snakemake-assembly-postprocessing
33-
```
34-
35-
**Step 4: Install PGAP**
36-
37-
- if you want to use [PGAP](https://github.com/ncbi/pgap) for annotation, it needs to be installed separately
38-
- PGAP can be downloaded from https://github.com/ncbi/pgap. Please follow the installation instructions there.
39-
- Define the path to the `pgap.py` script (located in the `scripts` folder) in the `config` file (recommended: `./resources`)
40-
4113
## Running the workflow
4214

4315
### Input data
@@ -48,3 +20,5 @@ The samplesheet table has the following layout:
4820
| sample | species | strain | id_prefix | file |
4921
| ------ | ------------------------ | ------ | --------- | -------------- |
5022
| EC2224 | "Streptococcus pyogenes" | SF370 | SPY | assembly.fasta |
23+
24+
**Note:** Pangenome analysis with `Panaroo` requires at least two samples.

resources/images/dag.svg

Lines changed: 157 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)