Star build reference

Create a reference for STAR from a set of fasta files.

Info

ID: star_build_reference
Namespace: mapping

Example commands

You can run the pipeline using nextflow run.

View help

You can use --help as a parameter to get an overview of the possible parameters.

nextflow run openpipelines-bio/openpipeline \
  -r 0.12.6 -latest \
  -main-script target/nextflow/mapping/star_build_reference/main.nf \
  --help

Run command

Example of params.yaml
# Input/Output
genome_fasta: # please fill in - example: ["chr1.fasta", "chr2.fasta"]
# transcriptome_gtf: "path/to/file"
# output: "$id.$key.output.output"

# Genome indexing arguments
genomeSAindexNbases: 14

# Nextflow input-output arguments
publish_dir: # please fill in - example: "output/"
# param_list: "my_params.yaml"
nextflow run openpipelines-bio/openpipeline \
  -r 0.12.6 -latest \
  -profile docker \
  -main-script target/nextflow/mapping/star_build_reference/main.nf \
  -params-file params.yaml
Note

Replace -profile docker with -profile podman or -profile singularity depending on the desired backend.

Argument groups

Input/Output

Name Description Attributes
--genome_fasta The fasta files to be included in the reference. Corresponds to the –genomeFastaFiles argument in the STAR command. List of file, required, example: "chr1.fasta", "chr2.fasta", multiple_sep: " "
--transcriptome_gtf Specifies the path to the file with annotated transcripts in the standard GTF format. STAR will extract splice junctions from this file and use them to greatly improve accuracy of the mapping. Corresponds to the –sjdbGTFfile argument in the STAR command. file
--output Path to output directory. Corresponds to the –genomeDir argument in the STAR command. file, required, example: "/path/to/foo"

Genome indexing arguments

Name Description Attributes
--genomeSAindexNbases Length (bases) of the SA pre-indexing string. Typically between 10 and 15. Longer strings will use much more memory, but allow faster searches. For small genomes, the parameter {genomeSAindexNbases must be scaled down to min(14, log2(GenomeLength)/2 - 1). integer, default: 14

Authors

  • Dries Schaumont (author)