sequenceAlignmentTopHat: Use the Tophat tool to align reads

Description Usage Arguments Details Note

View source: R/RNASeqPipelineR.R

Description

Uses Tophat to align reads in FASTQ files against the reference genome hg38 from UCSC database. Optionally you can specify paired end reads. The code assumes paired reads have fastq files that differ by one character (i.e. sampleA_read1.fastq, sampleA_read2.fastq) and will perform matching of paired fastq files based on that assumption using string edit distance. Read 1 is assumed to be upstream and read 2 is assumed to be downstream.

Usage

1
2
3
4
5
  sequenceAlignmentTopHat(path = "/shared/silo_researcher/Gottardo_R/jingyuan_working/iGenome/Mus_musculus/UCSC/mm10",
  parallel_threads = 1, tophat_threads = 6, paired = FALSE,
  nchunks = 10, days_requested = 5, slurm = FALSE,
  slurm_partition = "gottardo_r", ram_per_node = tophat_threads *
  parallel_threads * 1200)

Arguments

path

character specifying an absolute path path to the iGenome directory.

parallel_threads

integer specify how many parallel processes to spawn

tophat_threads

integer specify how many threads bowtie should use.

paired

logical specify whether you have paried reads or not.

nchunks

integer number of chunks to split the files for a slurm job. Ignored if slurm = FALSE

days_requested

integer number of days requested for the job (when submitting a slurm job). Ignored if slurm = FALSE

slurm

logical if TRUE job is submitted as a slurm batch job, otherwise it's run on the local machine. Slurm jobs will honour the nchunks and days_requested arguments.

slurm_partition

character the slurm partition to submit to. Ignored if slurm=FALSE

ram_per_node

numeric The number of Mb per node. Ignored if slurm=FALSE. Default of parallel_threads*bowtie_threads*1000

Details

The number of parallel_threads*tophat_threads should not be more than the number of cores available on your system.

Note

The amount of memory requested should be set to bowtie_threads*parallel_threads*1G as this is the default requested by samtools for sorting. If insufficient memory is requested, the bam files will not be created successfully.


RGLab/RNASeqPipelineR documentation built on Jan. 19, 2020, 12:31 a.m.