From 6178249bbb5e9de7cb7f34287ee7de28a68fed6c Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Wed, 10 Aug 2022 15:38:17 +0200 Subject: Change dev branch used for docs, update static docs --- docs/dev/reference/mkinds.html | 277 ++++++++++++++++++----------------------- 1 file changed, 123 insertions(+), 154 deletions(-) (limited to 'docs/dev/reference/mkinds.html') diff --git a/docs/dev/reference/mkinds.html b/docs/dev/reference/mkinds.html index 0d1de46d..b571e3a0 100644 --- a/docs/dev/reference/mkinds.html +++ b/docs/dev/reference/mkinds.html @@ -1,70 +1,15 @@ - - - - - - - -A dataset class for mkin — mkinds • mkin - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -A dataset class for mkin — mkinds • mkin - - - - - - - - - - - - - + + -
-
- -
- -
+

A dataset class for mkin

- Source: R/mkinds.R + Source: R/mkinds.R
@@ -153,118 +92,148 @@ such as the on contained in the data field of mkinds objects. Some datasets provided by this package come as mkinds objects nevertheless.

- 
# S3 method for mkinds
-print(x, data = FALSE, ...)
+
+ 
# S3 method for mkinds
+print(x, data = FALSE, ...)
+
+ +
+

Arguments

+
x
+

An mkinds object.

+ + +
data
+

Should the data be printed?

+ + +
...
+

Not used.

-

Arguments

- - - - - - - - - - - - - - -
x

An mkinds object.

data

Should the data be printed?

...

Not used.

+
+
+

Public fields

+

title
+

A full title for the dataset

-

Public fields

-

-
title

A full title for the dataset

+
sampling_times
+

The sampling times

-
sampling_times

The sampling times

-
time_unit

The time unit

+
time_unit
+

The time unit

-
observed

Names of the observed variables

-
unit

The unit of the observations

+
observed
+

Names of the observed variables

-
replicates

The maximum number of replicates per sampling time

-
data

A data frame with at least the columns name, time +

unit
+

The unit of the observations

+ + +
replicates
+

The maximum number of replicates per sampling time

+ + +
data
+

A data frame with at least the columns name, time and value in order to be compatible with mkinfit

-

-

Methods

+

+
+
+

Methods

-

Public methods

+
+

Public methods

+ +

+

Method new()

+

Create a new mkinds object

+

Usage

+

mkinds$new(title = "", data, time_unit = NA, unit = NA)

+
- -

-

Method new()

-

Create a new mkinds object

Usage

-

mkinds$new(title = "", data, time_unit = NA, unit = NA)

+
+

Arguments

+

title
+

The dataset title

-

Arguments

-

-
title

The dataset title

-
data

The data

+
data
+

The data

-
time_unit

The time unit

-
unit

The unit of the observations

+
time_unit
+

The time unit

-

-

-

Method clone()

-

The objects of this class are cloneable with this method.

Usage

-

mkinds$clone(deep = FALSE)

-

Arguments

-

-
deep

Whether to make a deep clone.

+
unit
+

The unit of the observations

-

+

+
+ +

+

Method clone()

+

The objects of this class are cloneable with this method.

+

Usage

+

mkinds$clone(deep = FALSE)

+
+ +
+

Arguments

+

deep
+

Whether to make a deep clone.

-

Examples

- 

-mds <- mkinds$new("FOCUS A", FOCUS_2006_A)
-print(mds)
-
#> <mkinds> with $title:  FOCUS A 
-#> Observed compounds $observed:  parent 
-#> Sampling times $sampling_times:
-#> 0, 3, 7, 14, 30, 62, 90, 118 
-#> With a maximum of  1  replicates

-
+

+
+ +
+ +
+ +
+

Examples

+ 

+mds <- mkinds$new("FOCUS A", FOCUS_2006_A)
+print(mds)
+#> <mkinds> with $title:  FOCUS A 
+#> Observed compounds $observed:  parent 
+#> Sampling times $sampling_times:
+#> 0, 3, 7, 14, 30, 62, 90, 118 
+#> With a maximum of  1  replicates
+
+
+
+
- - - + + -- cgit v1.2.1