ct.resultCheck: Determine whether a supplied object contains the results of a...

In OscarBrock/gCrisprTools: Suite of Functions for Pooled Crispr Screen QC and Analysis

Determine whether a supplied object contains the results of a Pooled Screen

Description

Many gCrisprTools functions operate on a data.frame of results generated by a CRISPR screen. This function takes in a supplied object and returns a logical indicating whether the object can be treated as one of these data.frames for the purposes of downstream analyses. This is largely used internally, but can be useful if a user needs to build a result object for some reason.

Usage

ct.resultCheck(summaryDF)

Arguments

summaryDF

A data.frame, usually returned by ct.generateResults. if you need to generate one of these by hand for some reason, see the example resultsDF object loaded in the example below.

Value

A logical indicating whether the object is of the appropriate format.

Author(s)

Russell Bainer

Examples

data('resultsDF')
ct.resultCheck(resultsDF)

OscarBrock/gCrisprTools documentation built on Oct. 25, 2022, 7:29 a.m.