Introduction
sanger-tol/ensembldownload is a pipeline that downloads gene and repeat annotations from Ensembl into a Tree of Life directory structure.
The pipeline takes a CSV file that contains assembly accession number, output directories, geneset methods and geneset versions.
The pipeline then downloads from Ensembl the data associated with this geneset.
All files are compressed with bgzip, and indexed with samtools faidx or tabix.
Steps involved:
- Download from Ensembl the gene annotation (GFF3 file and sequences of the genes in Fasta format.
- Download from Ensembl the masked genome (Fasta) and extract the coordinates of the masked regions into a BED file.
- Ensure all Fasta files are compressed with
bgzipand indexed withsamtools faidx. - Ensure all GFF3 files are compressed with
bgzipand indexed withtabix. - Ensure all BED files are compressed with
bgzipand indexed withtabix.
Usage
[!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.
[!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.
The easiest is to provide version of the assembly and annotations like this:
nextflow run sanger-tol/ensembldownload --assembly_accession GCA_905163415.1 --annotation_method braker --geneset_version 2022_03
[!WARNING] Please provide pipeline parameters via the CLI or Nextflow
-params-fileoption. Custom config files including those provided by the-cNextflow option can be used to provide any configuration except for parameters; see docs.
The pipeline also supports bulk downloads through a sample-sheet. More information about this mode on our pipeline website.
Credits
sanger-tol/ensembldownload was originally written by Matthieu Muffato.
We thank the following people for their assistance in the development of the predecessors of this pipeline:
Contributions and Support
If you would like to contribute to this pipeline, please see the contributing guidelines.
Citations
If you use sanger-tol/ensembldownload for your analysis, please cite it using the following doi: 10.5281/zenodo.7155206
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.
Command copied!