From 575fcacaa33076de97f41a79afb37efb97ca82e0 Mon Sep 17 00:00:00 2001
From: Johannes Ranke A dataset class for mkinmkinds
Format
@@ -164,6 +163,33 @@
value in order to be compatible with mkinfit
new()
mkinds$new(title = "", data, time_unit = NA, unit = NA)
clone()
The objects of this class are cloneable with this method.
mkinds$clone(deep = FALSE)
deep
Whether to make a deep clone.
@@ -174,6 +200,7 @@ value in order to be compatible with mkinfit-- cgit v1.2.1 From 64a476750ff57f4c612620bd58cc4ac42812e185 Mon Sep 17 00:00:00 2001 From: Johannes RankeDate: Tue, 31 Mar 2020 09:52:19 +0200 Subject: Use inline documentation for R6 class mkinds --- docs/reference/mkinds.html | 64 +++++++++++++++++++++++++++++----------------- 1 file changed, 41 insertions(+), 23 deletions(-) (limited to 'docs/reference/mkinds.html') diff --git a/docs/reference/mkinds.html b/docs/reference/mkinds.html index c1cdcf99..ef6fb35c 100644 --- a/docs/reference/mkinds.html +++ b/docs/reference/mkinds.html @@ -36,7 +36,10 @@ - + @@ -133,36 +136,36 @@ --A dataset class for mkin
+At the moment this dataset class is hardly used in mkin. For example, +mkinfit does not take mkinds datasets as argument, but works with dataframes +such as the on contained in the data field of mkinds objects. Some datasets +provided by this package come as mkinds objects nevertheless.
Format
+See also
-An
-R6Class
generator object.Fields
++The S3 printing method
print.mkinds
Public fields
- - - -
A full title for the dataset
title
A full title for the dataset
times The sampling times
sampling_times
The sampling times
The time unit
time_unit
The time unit
Names of the observed compounds
observed
Names of the observed variables
The unit of the observations
unit
The unit of the observations
The number of replicates
replicates
The maximum number of replicates per sampling time
A dataframe with at least the columns name, time and -value in order to be compatible with mkinfit
data
A data frame with at least the columns name, time +and value in order to be compatible with mkinfit
new()
Create a new mkinds object
mkinds$new(title = "", data, time_unit = NA, unit = NA)
title
The dataset title
data
The data
time_unit
The time unit
unit
The unit of the observations
clone()
The objects of this class are cloneable with this method.
+mds <- mkinds$new("FOCUS A", FOCUS_2006_A) +print(mds)-mds <- mkinds$new("FOCUS A", FOCUS_2006_A)