ComputeResult-class: Compute Result

In VEuPathDB/veupathUtils: General Helper Functions for VEuPathDB Projects

Compute Result

Description

A class for consistently representing the results of computes. This includes their representation in R, as JSON and how they are written to files.

Slots

data

A data.frame of values where computed variables are columns and samples rows.

name

The name of the compute, ex: 'alphaDiv'.

recordIdColumn

The name of the column containing IDs for the samples. All other columns will be treated as computed values.

ancestorIdColumns

A character vector of column names representing parent entities of the recordIdColumn.

computedVariableMetadata

veupathUtils::VariableMetadataList detailing the computed variables.

statistics

An optional slot of any values. List or data.frame are recommended. It is not required to have rows or cols map to samples.

computationDetails

An optional message about the computed results.

parameters

A record of the input parameters used to generate the computed results.

droppedColumns

A character vector of column names that have been dropped for being unsuitable for the computation.

VEuPathDB/veupathUtils documentation built on Feb. 8, 2025, 12:29 p.m.