makeResultDir: Make Results Directory

Description Usage Arguments Details Value Examples

Description

Creates a timestamped results directory.

Usage

1
makeResultDir(path = NULL, keep_images = 0)

Arguments

path

A character string giving the location where the results directory will be created.

keep_images

A logical (default=0).

Details

makeResultDir creates a timestamped results directory in the current working directory or in the path specified using path.

By default, when the HTML report is generated, the images used in the report are removed. If keep_images is set to 1 in the configuration file (see importConfig), then a folder called images is created as a subdirectory of the results directory. All of the images used in the HTML report will then be stored in this subdirectory.

Value

name of the timestamped results directory

Examples

1
2
3
4
5
 # With no image subdirectory
 makeResultDir(path=getwd())

 # With image subdirectory
 makeResultDir(path=getwd(), keep_images=1)

sanger-pathogens/deago documentation built on May 28, 2019, 8:42 a.m.