plant-food-research-open/genepal is a bioinformatics pipeline for single genome, multiple genomes and pan-genome annotation. An overview is shown in the Pipeline Flowchart and the references for the tools are listed in CITATIONS.md.
- FASTA VALIDATOR: Validate genome fasta
- REPEATMODELER or EDTA: Create TE library
- REPEATMASKER: Soft mask the genome fasta
- FASTQC, FASTP, SORTMERNA: QC, trim and filter RNASeq evidence
- STAR: RNASeq alignment
- BRAKER: Annotate the genome fasta
- LIFTOFF: Liftoff annotations from reference genome fasta/gff
- TSEBRA, AGAT: Merge BRAKER and Liftoff annotations
- EGGNOG-MAPPER: Add functional annotation to gff
- ORTHOFINDER: Perform phylogenetic orthology inference across input genomes
- GENOMETOOLS, GFFREAD: Final GFF format validation and extraction of protein sequences
- BUSCO: Completeness statistics for genome and annotation through proteins
Refer to usage, parameters and output documents for details.
Note
If you are new to Nextflow and nf-core, please refer to this page on how to set-up Nextflow. Make sure to test your setup with -profile test
before running the workflow on actual data.
First, prepare an assemblysheet with your input genomes that looks as follows:
assemblysheet.csv
:
tag ,fasta ,is_masked
a_thaliana ,/path/to/genome.fa ,yes
Each row represents an input genome and the fields are:
tag:
A unique tag which represents the genome throughout the pipelinefasta:
fasta file for the genomeis_masked
: yes or no to denote whether the fasta file is already masked or not
At minimum, a file with proteins as evidence is also required. Now, you can run the pipeline using:
nextflow run plant-food-research-open/genepal \
-profile <docker/singularity/.../institute> \
--input assemblysheet.csv \
--protein_evidence proteins.faa \
--outdir <OUTDIR>
Warning
Please provide pipeline parameters via the CLI or Nextflow -params-file
option. Custom config files including those provided by the -c
Nextflow option can be used to provide any configuration except for parameters;
see docs.
Download the pipeline to your /workspace/$USER
folder. Change the parameters defined in the pfr/params.json file. Submit the pipeline to SLURM for execution.
sbatch ./pfr_genepal
plant-food-research-open/genepal workflows were originally scripted by Jason Shiller (@jasonshiller). Usman Rashid (@gallvp) wrote the Nextflow pipeline.
We thank the following people for their extensive assistance in the development of this pipeline:
- Cecilia Deng @CeciliaDeng
- Charles David @charlesdavid
- Chen Wu @christinawu2008
- Leonardo Salgado @leorippel
- Ross Crowhurst @rosscrowhurst
- Susan Thomson @cflsjt
- Ting-Hsuan Chen @ting-hsuan-chen
The pipeline uses nf-core modules contributed by following authors:
If you would like to contribute to this pipeline, please see the contributing guidelines.
An extensive list of references for the tools used by the pipeline can be found in the CITATIONS.md
file.
This pipeline uses code and infrastructure developed and maintained by the nf-core community, reused here under the MIT license.
The nf-core framework for community-curated bioinformatics pipelines.
Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.
Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x.