rnb.build.index {RnBeads} | R Documentation

## rnb.build.index

### Description

Creates an HTML index file that contains listing of all available RnBeads reports. If no known reports are found in the specified directory, no index is created.

### Usage

    rnb.build.index(
      dir.reports,
      fname = "index.html",
      dir.configuration = "configuration",
      open.index = TRUE
    )

### Arguments

`dir.reports` | Directory that contains HTML reports generated by RnBeads modules. If this directory does not exist, is a regular file, is inaccessible, or does not contain any recognizable HTML report files, this function does not generate an HTML index file and produces an error or a warning message.
`fname` | One-element `character` vector specifying the name of the index file to be generated. See the Details section for restrictions on the name. The file will be created in `dir.reports`. If such a file already exists, it will be overwritten.
`dir.configuration` | Subdirectory that hosts configuration files shared by the reports. This must be a `character` vector of length one that gives location as a path relative to `dir.reports`. Strong restrictions apply to the path name. See the description of the `createReport` function for more details.
`open.index` | Flag indicating if the index should be displayed after it is created. If this is `TRUE`, `rnb.show.report` is called to open the generated HTML file.

### Details

In order to ensure independence of the operating system, there are strong restrictions on the name of the index file. It can consist of the following symbols only: Latin letters, digits, dot (`.`), dash (`-`) and underline (`_`). The extension of the file must be one of `htm`, `html`, `xhtml` or `xml`. The name must not include paths, that is, slash (`/`) or backslash (`\`) cannot be used. In addition, it cannot be any of the recognized RnBeads report file names.

### Value

Names of all HTML report files that were referenced in the newly generated index, invisibly. The order of the file names is the same as the one they are listed in the index. If no known reports are found in the given directory, the returned value is an empty `character` vector.

### Author(s)

Yassen Assenov

### See Also

`rnb.run.analysis`, `rnb.initialize.reports`

[Package RnBeads version 2.10.0 Index]