mkindsg: A class for dataset groups for mkin

Description Usage Arguments Public fields Methods Examples

Description

A container for working with datasets that share at least one compound, so that combined evaluations are desirable.

Time normalisation factors are initialised with a value of 1 for each dataset if no data are supplied.

Usage

1
2
## S3 method for class 'mkindsg'
print(x, data = FALSE, verbose = data, ...)

Arguments

x

An mkindsg object.

data

Should the mkinds objects be printed with their data?

verbose

Should the mkinds objects be printed?

...

Not used.

Public fields

title

A title for the dataset group

ds

A list of mkinds objects

observed_n

Occurrence counts of compounds in datasets

f_time_norm

Time normalisation factors

meta

A data frame with a row for each dataset, containing additional information in the form of categorical data (factors) or numerical data (e.g. temperature, moisture, or covariates like soil pH).

Methods

Public methods


Method new()

Create a new mkindsg object

Usage
mkindsg$new(title = "", ds, f_time_norm = rep(1, length(ds)), meta)
Arguments
title

The title

ds

A list of mkinds objects

f_time_norm

Time normalisation factors

meta

The meta data


Method clone()

The objects of this class are cloneable with this method.

Usage
mkindsg$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

1
2
3
4
mdsg <- mkindsg$new("Experimental X", experimental_data_for_UBA_2019[6:10])
print(mdsg)
print(mdsg, verbose = TRUE)
print(mdsg, verbose = TRUE, data = TRUE)

mkin documentation built on Sept. 15, 2021, 5:06 p.m.