Skip to content

Commit 1b57359

Browse files
authored
Update README.md
Updated to include chopper and mention allowed use of .fastq files as well. Signed-off-by: Ian M. B. <99409346+iPsychonaut@users.noreply.github.com>
1 parent d5e1366 commit 1b57359

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ This application is designed to be run on a Linux/WSL environment and requires t
2525
- blast==2.15.0
2626
- pyvcf==0.6.8
2727
- fastqc==0.12.1
28+
- chopper==0.7.0
2829

2930
The application also relies on the following tools:
3031
- NGSpeciesID (https://github.com/ksahlin/NGSpeciesID)
@@ -47,7 +48,7 @@ mamba install -y -c bioconda -c conda-forge -c agbiome -c prkrekel numpy==1.26.3
4748

4849
fundis_env installs
4950
```bash
50-
conda activate fundis_env && mamba install -y -c bioconda -c conda-forge -c agbiome -c prkrekel pandas==2.0.3 openblas==0.3.3 biopython==1.81 samtools==1.18 minimap2==2.26 bcftools==1.17 bwa==0.7.17 whatshap==2.1 spoa==4.1.3 racon==1.5.0 psutil==5.9.8 blast==2.15.0 pyvcf==0.6.8 fastqc==0.12.1 && pip install NGSpeciesID && conda deactivate
51+
conda activate fundis_env && mamba install -y -c bioconda -c conda-forge -c agbiome -c prkrekel pandas==2.0.3 openblas==0.3.3 biopython==1.81 samtools==1.18 minimap2==2.26 bcftools==1.17 bwa==0.7.17 whatshap==2.1 spoa==4.1.3 racon==1.5.0 psutil==5.9.8 blast==2.15.0 pyvcf==0.6.8 fastqc==0.12.1 chopper==0.7.0 && pip install NGSpeciesID && conda deactivate
5152
```
5253

5354
medaka env installs
@@ -80,11 +81,11 @@ conda activate medaka && mamba install -y -c bioconda -c conda-forge -c agbiome
8081
5. **MycoMap Summarizer (MycoMap_Summarize.py)** (https://www.protocols.io/view/primary-data-analysis-basecalling-demultiplexing-a-dm6gpbm88lzp/v3?step=3):
8182
- Aggregates results from the entire pipeline.
8283
- Produces comprehensive summary reports for analysis and interpretation.
83-
- Simplifies data review and sharing.
84+
- Simplifies data review and sharing via MycoMap.
8485

8586
## Inputs and Outputs
8687

87-
- **Input**: `.fastq.gz` file containing Oxford Nanopore Guppy Basecalled sequences.
88+
- **Input**: `.fastq.gz` or `.fastq` file containing Oxford Nanopore Guppy Basecalled sequences.
8889
- **Outputs**:
8990
- Processed and quality-checked sequence data.
9091
- Species identification reports and detailed analysis.
@@ -101,11 +102,11 @@ conda activate fundis_env && python FunDiS_GUI.py
101102
Then navigate the GUI to select your input files. Here’s a brief guide on using each module:
102103

103104
- **GUI**: Launch the GUI script to access the pipeline's functionalities. The interface is intuitive and guides you through the process.
104-
- **Mini-Barcoder**: After selecting your `.fastq.gz` file, this module will prepare it for the NGSpeciesID analysis.
105+
- **Mini-Barcoder**: After selecting your `.fastq.gz` or `.fastq` file, this module will prepare it for the NGSpeciesID analysis by running Chopper and Minibar.
105106
- **NGSpeciesID**: Once the data is prepped, use this module for species identification. The output will include detailed species information.
106107
- **Haplotype Phaser**: An advanced setting that will perform a dual analysis and preserve haplotypes with IUPAC ambiguities and lower-case letters for insertions/deletions.
107108
- **MycoMap Summarizer**: Finally, to aggregate and summarize your results, use this module. It consolidates the data into an easy-to-interpret format.
108-
- FEATURE PENDING **Haplotype Phaser**: An advanced setting that will use the Phased Haplotype file instead of the traditionally used medaka consensus file.
109+
- **Haplotype Phaser**: An advanced setting that will use the Phased Haplotype file instead of the traditionally used medaka consensus file.
109110

110111
For detailed instructions and options for each module, refer to the comments and documentation within each script file. These instructions provide guidance on executing the scripts and customizing the analysis to your requirements.
111112

0 commit comments

Comments
 (0)