GRgetDefs {GRmetrics} | R Documentation

## GR metrics definitions

### 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

    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

    # 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,]

[Package GRmetrics version 1.18.0 Index]