check_consistency {scsR} | R Documentation

## check_consistency

### Description

This method takes an siRNA screen as input and check its consistency (i.e. check that the format of the data is suitable for the usage with our scsR package). The method prints meaningful warnings for every inconsistency that can be detected

### Usage

    check_consistency(screen, scoreColName = "score", geneColName = "GeneID",
                                      seqColName="siRNA_seq")

### Arguments

`screen` | Dataframe containing the results of the siRNA scree
`scoreColName` | name of the column that contains the score of the screen (character vector)
`geneColName` | name of the column that contains the gene identifier of the screen (character vector)
`seqColName` | name of the column that contains the siRNA sequences in the screen. (the sequences have to be provided in the guide/antisense orientation and each sequence must be in the format of a character vector, i.e. a simple string). (character vector)

### Value

return the data frame passed in input with possible consistency corrections.

### Author(s)

Andrea Franceschini

### Examples

    data(uuk_screen)
    uuk_screen <- check_consistency(uuk_screen)

[Package scsR version 1.20.0 Index]