use.caRpools: Starting caRpools eport generation from R console

In caRpools: CRISPR AnalyzeR for Pooled CRISPR Screens

Description

Moreover, caRpools report generation can also be initiated without R-studio installation, so that this can be done via R command line even on remote computers. In this case, caRpools report generation can be started via 'use.caRpools' with additional parameters, which are described below.

Usage

use.caRpools(type=NULL, file="CaRpools-extended-PDF.Rmd",
miaccs="MIACCS.xls", check=TRUE, work.dir=NULL)

Arguments

type	*Description* If you provide a custom Rmd template that can generate both, PDF and HTML reports you can indicate which version you want to generate. *Default* NULL *Values* "PDF", "HTML"
file	*Description* The file name of your custom Rmd template file (with extension). *Default* "CaRpools-extended-PDF.Rmd" *Values* filename as character
miaccs	*Description* The filename of your MIACCS file. *Default* "MIACCS.xls" *Values* filename as character
check	*Description* Indicates whether caRpools will check for correct installation and file access. *Default* TRUE *Values* TRUE or FALSE (boolean)
work.dir	*Description* You can provide the absolute path to the working directory in which all files are placed (e.g. the MIACCS.xls and Rmd template). *Default* NULL *Values* absolute path (character) or NULL if standard R working directory is used

Details

none

Value

Start caRpools report generation, so no direct return value is generated.

Note

none

Author(s)

Jan Winter

Examples

data(caRpools)
#use.caRpools(check=FALSE)

caRpools documentation built on May 2, 2019, 11:26 a.m.