rnb.initialize.reports {RnBeads} | R Documentation

## rnb.initialize.reports

### Description

Creates a new directory to host HTML reports and copies the shared configuration files.

### Usage

    rnb.initialize.reports(dir.reports, dir.configuration = "configuration")

### Arguments

`dir.reports` | Directory to host report files. This must be a `character` of length one that specifies a non-existent path, as this methods attempts to create it.
`dir.configuration` | Subdirectory to host configuration files shared by the reports. This must be a `character` of length one that gives location as a path relative to `dir.reports`. Also, strong restrictions apply to the path name. See the description of the `createReport` function for more details. This method creates the directory and copies configuration files that define cascading style sheet (CSS) definitions and Javascript functions used by the HTML reports.

### Value

`TRUE` if the report directory was successfully created and the configuration files were copied to the specified location; `FALSE` otherwise.

### Author(s)

Yassen Assenov

### See Also

`createReport` for initializing an HTML report

### Examples

    dir.reports <- "~/infinium_studies/cancer_study/reports"
    if (!rnb.initialize.reports(dir.reports)) {
        cat("ERROR: Could not initialize configuration in ", dir.reports, "\n", sep = "")
    }

[Package RnBeads version 1.12.1 Index]