ttest.createRmd: Generate a '.Rmd' file containing code to perform...

Description Usage Arguments Details Value Author(s) References Examples

View source: R/generateRmdCodeDiffExp.R

Description

A function to generate code that can be run to perform differential expression analysis of RNAseq data (comparing two conditions) using a t-test, applied to the normalized counts. The code is written to a .Rmd file. This function is generally not called by the user, the main interface for performing differential expression analysis is the runDiffExp function.

Usage

1
ttest.createRmd(data.path, result.path, codefile, norm.method)

Arguments

data.path

The path to a .rds file containing the compData object that will be used for the differential expression analysis.

result.path

The path to the file where the result object will be saved.

codefile

The path to the file where the code will be written.

norm.method

The between-sample normalization method used to compensate for varying library sizes and composition in the differential expression analysis. The normalization factors are calculated using the calcNormFactors function from the edgeR package. Possible values are "TMM", "RLE", "upperquartile" and "none"

Details

For more information about the methods and the interpretation of the parameters, see the edgeR package and the corresponding publications.

Value

The function generates a .Rmd file containing the code for performing the differential expression analysis. This file can be executed using e.g. the knitr package.

Author(s)

Charlotte Soneson

References

Robinson MD, McCarthy DJ and Smyth GK (2010): edgeR: a Bioconductor package for differential expression analysis of digital gene expression data. Bioinformatics 26, 139-140

Robinson MD and Oshlack A (2010): A scaling normalization method for differential expression analysis of RNA-seq data. Genome Biology 11:R25

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
try(
if (require(genefilter)) {
tmpdir <- normalizePath(tempdir(), winslash = "/")
mydata.obj <- generateSyntheticData(dataset = "mydata", n.vars = 1000, 
                                    samples.per.cond = 5, n.diffexp = 100, 
                                    output.file = file.path(tmpdir, "mydata.rds"))
runDiffExp(data.file = file.path(tmpdir, "mydata.rds"), result.extent = "ttest", 
           Rmdfunction = "ttest.createRmd", 
           output.directory = tmpdir, norm.method = "TMM")
})

Example output

Loading required package: sm
Package 'sm', version 2.2-5.6: type help(sm) for summary information
Warning message:
no DISPLAY variable so Tk is not available 
Loading required package: genefilter


processing file: tempcode.Rmd

  |                                                                       
  |                                                                 |   0%
  |                                                                       
  |................................                                 |  50%
  ordinary text without R code


  |                                                                       
  |.................................................................| 100%
label: unnamed-chunk-1 (with options) 
List of 6
 $ echo   : logi TRUE
 $ eval   : logi TRUE
 $ include: logi TRUE
 $ message: logi FALSE
 $ error  : logi TRUE
 $ warning: logi TRUE

Loading required package: edgeR
Loading required package: limma
sh: 1: cannot create /dev/null: Permission denied

output file: tempcode.md

[1] TRUE

compcodeR documentation built on Nov. 10, 2020, 2 a.m.