SPEAQeasy can be run with hg38, hg19, mm10, or rat (
mRatBN7.2) references. The pipeline has a default and automated process for pulling and building annotation-related files, but the user can opt to provide their own annotation as an alternative. Both of these options are documented below. In general, the pipeline uses three types of files. Example files below are the ones used with default configuration when hg38 reference is selected.
- A genome assembly fasta: the reference genome to align reads to, like the file here (but unzipped)
- Gene annotation gtf: containing transcript data, like the file here (but unzipped)
- A transcripts fasta: with the actual transcript sequences, such as the file here (but unzipped)
At LIBD, most human data after 2017 has been processed with GENCODE v25, which is the default in SPEAQeasy at JHPCE. Note that considerably newer versions are available, with frequent updates as visible from GENCODE’s website. The older default of v25 promotes compatibility across time at the potential expense of being up to date.
With genome and transcript annotation constantly being updated, the user may want to use a particular GENCODE release or Ensembl version. For each species, there is a corresponding configuration variable you may set to control the versions used. The variables
gencode_version_mouse refer to the GENCODE release number. Similarly, the variable
ensembl_version_rat specifies the Ensembl version for rat: note that
Rnor_6.0 is used when
ensembl_version_rat < 105, and
mRatBN7.2 is used for releases after and including 105.
Depending on the analysis you are doing, you may wish to only consider the reference chromosomes (for humans, the 25 sequences chr1 through chrM) for alignment and transcript quantification. SPEAQeasy provides the option to choose from two annotation “builds” for a given release and reference, called “main” and “primary” (following the naming convention from GENCODE databases).
- The “main” build consists of only the canonical “reference” sequences for each species
- The “primary” build consists of the canonical “reference” sequences and additional scaffolds, as a genome primary assembly fasta from GENCODE would contain.
See the variable
annotation_build in your configuration file for making this selection for your pipeline run. Please note that GENCODE does not provide transcript annotation for additional scaffolds for human and mouse, and so only the “main” transcripts are quantified, even when “primary” is selected (choice of “primary” does still affect alignment though, as expected)
A .bed file containing common SNV (single nucleotide variation) sites, at which variant calling is performed (for human and mouse). Variant calling is not currently supported for rat or mouse genomes.
An ERCC index: this is a file generated by Kallisto to prepare for quantifying ERCC spike-ins. The index is produced from the FASTA of ERCC transcript sequences, as in the file
You may wish to provide specific reference files in place of the automatically managed files described in the above section. In this case, you must supply the following files in the directory specified in the command-line option
- A genome assembly fasta (the reference genome to align reads to), such as the file here. Make sure the file has the string “assembly” in the filename, to specify to the pipeline that it is the genome reference fasta.
- Gene annotation gtf, such as the file here- but not gzipped. This file can have any name, so long as it ends in “.gtf”.
- A transcripts fasta, such as the file here- but not gzipped. Make sure to include “transcripts” anywhere in the filename (provided the file ends in “.fa”) to differentiate this file from the reference genome.
When using custom annotation, the configuration variables related to GENCODE/Enesmbl settings are ignored (i.e.
- An ERCC index (this is a file specific to Kallisto needed for ERCC quantification, which is an optional component of the pipeline). You can find the index used by default at
[repository directory]/Annotation/ERCC/ERCC92.idx. This file must end in “.idx”.
- A list of SNV sites at which to call variants (in .bed format). Variant calling is by default only enabled for human reference. You can find the .bed files used by default for “hg38” and “hg19” at
[repository directory]/Annotation/Genotyping/common_missense_SNVs_hg*.bed. This file can have any name provided it has the “.bed” extension.
You must also add the
--custom_anno [label] argument to your
run_pipeline_X.sh script, to specify you are using custom annotation files. The “label” is a string you want to include in filenames generated from the annotation files you provided. This is intended to allow the use of potentially many different custom annotations, assigned a unique and informative name you choose each time. This can be anything except an empty string (which internally signifies not to use custom annotation).