starchipCircle: Running starchip to detect circular RNAs on paired-end...

Description Usage Arguments Value Author(s) Examples

View source: R/starchipCircle.R

Description

This function execute starchip on a set of folders containing the output of starChimeric. It requires a specific bed generated with starChipIndex in teh genome folder used by starChimeric

Usage

1
2
3
4
starchipCircle(group = c("sudo", "docker"), genome.folder,
  scratch.folder, samples.folder, reads.cutoff, min.subject.limit, threads,
  do.splice = c("True", "False"), cpm.cutoff = 0,
  subjectCPM.cutoff = 0, annotation = c("true", "false"))

Arguments

group,

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

genome.folder,

a character string indicating the folder where the indexed reference genome for STAR is located.

scratch.folder,

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

samples.folder,

the folder where are located all the folders of the samples processed with starChimeric

reads.cutoff,

Integer. Minimum number of reads crossing the circular RNA backsplice required.

min.subject.limit,

Integer. Minimum number of individuals with readsCutoff reads required to carry forward a cRNA for analysis

threads,

Integer. Number of threads to use

do.splice,

true false. The splices within the cRNA be detected and reported. Linear splices are searched within each cRNA in each individual. Any linear splice with >= 60% of the read count of the cRNA is considered a splice within the cRNA. Two files are then created, .consensus with most common splice pattern, and .allvariants with all reported splice patterns.

cpm.cutoff,

Float. Reads counts are loaded into R and log2(CountsPerMillion) is calculated using the limma package. With cpmCutoff > 0, cRNA with log2(CPM) below this value will be filtered from this analysis

subjectCPM.cutoff,

Integer. See above. This value is the lower limit for number of individuals required to have the cRNA expressed at a value higher than cpmCutoff.

annotation,

rue/false. cRNA are provided with gene annotations

Value

1. Count matrixes : raw cRNA backsplice counts: circRNA.cutoff[readthreshold]reads.[subjectthreshold]ind.countmatrix log2CPM of above: norm_log2_counts_circRNA.[readthreshold]reads.[subjectthreshold]ind.0cpm_0samples.txt Maximum Linear Splices at Circular Loci: rawdata/linear.[readthreshold]reads.[subjectthreshold]ind.sjmax 2. Info about each circRNA: Consensus Information about Internal Splicing: Circs[reads].[subjects].spliced.consensus Complete Gene Annotation: circRNA.[readthreshold]reads.[subjectthreshold]ind.annotated Consise Gene Annotation + Splice Type: circRNA.[readthreshold]reads.[subjectthreshold]ind.genes 3. Images: PCA plots: circRNA.[readthreshold]reads.[subjectthreshold]ind.0cpm_0samples_variance_PCA.pdf Heatmap: circRNA.[readthreshold]reads.[subjectthreshold]ind.heatmap.pdf

Author(s)

Raffaele Calogero, raffaele.calogero [at] unito [dot] it, Bioinformatics and Genomics unit, University of Torino Italy

Examples

1
2
3
4
5
6
7
## Not run: 
    #downloading fastq files
    starchipCircle(group="docker", genome.folder="/data/genomes/hg38star", scratch.folder="/data/scratch",
                       samples.folder=getwd(), reads.cutoff=1, min.subject.limit=2, threads=8,
                       do.splice = "True", cpm.cutoff=0, subjectCPM.cutoff=0, annotation="true")

## End(Not run)

kendomaniac/docker4seq documentation built on Dec. 1, 2018, 6:54 a.m.