rsemstar: Running RSEM, Li and Dewey BMC Bioinformatics 2011 12:323

View source: R/rsemStar.R

rsemstarR Documentation

Running RSEM, Li and Dewey BMC Bioinformatics 2011 12:323

Description

This function executes the docker container rsemstar1, where RSEM is used to calculate gene/isoforms counts using as mapper STAR, Dubin et al. Bioinformatics. 2013 Jan 1;29(1):15-21

Usage

rsemstar(
  group = c("sudo", "docker"),
  fastq.folder = getwd(),
  scratch.folder = "/data/scratch",
  genome.folder,
  seq.type = c("se", "pe"),
  strandness = c("none", "forward", "reverse"),
  threads = 1,
  save.bam = TRUE
)

Arguments

group

a character string. Two options: "sudo" or "docker", depending to which group the user belongs

fastq.folder

a character string indicating where gzip fastq files are located

scratch.folder

a character string indicating the scratch folder where docker container will be mounted

genome.folder

a character string indicating the folder where the indexed reference genome for STAR is located. IMPORTANT the present function only suport genomic indexes made using ensembl genom and the corresponding gtf

seq.type

a character string indicating the type of reads to be trimmed. Two options: "se" or "pe" respectively for single end and pair end sequencing

strandness

a character string indicating the type ofsequencing protocol used for the analysis. Three options: "none", "forward", "reverse" respectively for non strand selection, forward for Illumina strandness protocols, reverse for ACCESS Illumina protocol

threads

a number indicating the number of cores to be used from the application

save.bam

a boolean TRUE FALSE to decide if bam files are saved

Value

three files: dedup_reads.bam, which is sorted and duplicates marked bam file, dedup_reads.bai, which is the index of the dedup_reads.bam, and dedup_reads.stats, which provides mapping statistics

Author(s)

Raffaele Calogero

Examples

## Not run: 
    #downloading fastq files
system("wget http://130.192.119.59/public/test_R1.fastq.gz")
system("wget http://130.192.119.59/public/test_R2.fastq.gz")
library(docker4seq)
#running rsemstar nostrand pe
rsemstar(group="docker",fastq.folder=getwd(), scratch.folder="/data/scratch/",
         genome.folder="/data/genomes/hg38star/", seq.type="pe", strandness="none",
         threads=8, save.bam = FALSE)


## End(Not run)

kendomaniac/docker4seq documentation built on Sept. 3, 2024, 6:42 p.m.