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.
1 2 3 4 5 6
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.
Subdirectory that hosts configuration files shared by the reports. This must be a
Flag indicating if the index should be displayed after it is created. If this is
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
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.
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
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.