mkReport: Creates a pdf report

Description Usage Arguments Details Note Examples

Description

Creates a pdf report summarizing the contents of the corObject

Usage

1
mkReport(obj, file, title = "Default \\texttt{miRComb} output", dat.sum.table = NULL, ddir = getwd() )

Arguments

obj

a corObject

file

name of the file, for example "myExampleReport"

title

Title of the report

dat.sum.table

Minimum dat.sum that will be applied to Table 9 and Figure 6.

ddir

output directory for the tex file. By default: current working directory

Details

Documents myExampleReport.tex and myExampleReport.pdf will be created on the working directory.

See PLoS ONE publication for more details: Vila-Casades├║s et al., "MiRComb: an R package to analyse miRNA-mRNA interactions. Examples across five digestive cancers". PLoS ONE, 2016.

Note

This function only works in Linux computers, with LaTeX and texlive already configured.

Some known problems and solutions:

Examples

1
2
3
4
5
6
### do not run

#data(data.obj)
#mkReport(data.obj,"myExampleReport")

### documents myExampleReport.tex and myExampleReport.pdf will be created

mariavica/mircomb documentation built on Feb. 3, 2020, 2:28 a.m.