chart_names: chart names

Description Usage Arguments Details Value Methods (by class) Examples

Description

Returns a list of valid charts for a struct object

Usage

1
2
3
4
chart_names(obj, ret = "char")

## S4 method for signature 'struct_class'
chart_names(obj, ret = "char")

Arguments

obj

An object derived from the struct_class object

ret

A string indicating whether a list of objects ('obj') or a list of chart names ('char') is returned. 'char' is default.

Details

The chart_names method searches chart objects that specify the input object type as an input.

Value

list of chart names, or a list of chart objects

Methods (by class)

Examples

1
2
3
4
M = example_model()
chart_names(M) # 'example_chart'
chart_names(M,'char') # as above
chart_names(M,'obj') # returns a list of chart objects

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