chart: Constructor for struct chart objects

Description Usage Arguments Details Value Examples

View source: R/chart_class.R

Description

A base class in the struct package. Should not be called directly.

Usage

1

Arguments

...

named slots and their values that get passed to struct_class

Details

The chart class provides a template for figures, charts and plots associated with other objects. For example, a DatasetExperiment object could have a histogram plotted for a specified column.

Charts can have parameters but not outputs (other than the figure itself), as chart objects are not intended to be used for calculations. The chart_plot method can be used to display a chart for an object, and chart_names can be used to list all chart objects associated with an object.

Classes that inherit the stato class have STATO integration enabled, allowing stato_id to be set and formal names and descriptions pulled from the STATO ontology database.

Value

a chart object

a struct_class object

Examples

1

computational-metabolomics/struct documentation built on Nov. 17, 2021, 8:57 a.m.