GRgetDefs: GR metrics definitions

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/GRaccessors.R

Description

Given a SummarizedExperiment object created by GRfit, this function returns a table with the definition of each GR metric and traditional metric that is calculated.

Usage

1
GRgetDefs(fitData)

Arguments

fitData

a SummarizedExperiment object, generated by the GRfit function.

Details

Given a SummarizedExperiment object created by GRfit, this function returns a table containing the definition of each GR metric, traditional metric, and goodness of fit measure in the object. This is simply a convenient accessor function, equivalent to rowData(fitData).

Value

A table of definitions of GR metrics and traditional metrics

Author(s)

Nicholas Clark

See Also

To create the object needed for this function, see GRfit.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
# Load Case A (example 1) input
data("inputCaseA")
head(inputCaseA)
# Run GRfit function with case = "A"
output1 = GRfit(inputData = inputCaseA,
groupingVariables = c('cell_line','agent'))
defs = GRgetDefs(output1)
# See all definitions (some will be truncated)
## Not run: View(defs)
# See the first six descriptions
head(defs)
# Look at a specific definition
defs[15,]

GRmetrics documentation built on Nov. 8, 2020, 8:06 p.m.