templateDescriptionFile {cellHTS2} | R Documentation

## Creates a template description file for an RNAi experiment

### Description

This function creates a template description file for an RNAi experiment with default entries compliant with MIAME class and with additional entries specific for a `cellHTS` object.

### Usage

      templateDescriptionFile(filename="Description.txt", path, force=FALSE)

### Arguments

`filename` | the name of the output file. Default is "Description.txt".
`path` | a character of length 1 indicating the path in which to create the screen description file. By default, it can extract the path from `filename`.
`force` | a logical value, determines the behaviour of the function if file `filename` exists. If `force` is `TRUE`, the function overwrites `filename`, otherwise it casts an error.

### Details

This function can be called to generate a template file for the RNAi experiment. This file contains the fields that are compliant with the `MIAME` class and also additional entries specific for the `cellHTS` class, which should be edited and completed by the user.

This file, which we call Screen description file, is required to configure the `cellHTS` object via function `configure`. It is intended to contain general information about the screen, such as its title, its goal, when and how it was performed, which organism, which library, type of assay, references, and any other information that is pertinent to the biological interpretation of the experiments.

### Value

The function returns a character with the full path and name of the file that was created.

### Author(s)

Ligia Bras ligia@ebi.ac.uk

### See Also

`configure`

### Examples

      out <- templateDescriptionFile("Description.txt", path=tempdir())
      out
      readLines(out)

[Package cellHTS2 version 2.46.1 Index]