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/CAKE_export.html | 282 ++++++++++++++---------------------- 1 file changed, 110 insertions(+), 172 deletions(-) (limited to 'docs/dev/reference/CAKE_export.html') diff --git a/docs/dev/reference/CAKE_export.html b/docs/dev/reference/CAKE_export.html index e187772f..47efd056 100644 --- a/docs/dev/reference/CAKE_export.html +++ b/docs/dev/reference/CAKE_export.html @@ -1,68 +1,13 @@ - - - - - - - -Export a list of datasets format to a CAKE study file — CAKE_export • mkin - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Export a list of datasets format to a CAKE study file — CAKE_export • mkin - + + - - - -
-
- -
- -
+

Export a list of datasets format to a CAKE study file

- Source: R/CAKE_export.R + Source: R/CAKE_export.R
@@ -149,116 +88,115 @@ specified as well." /> specified as well.

- 
CAKE_export(
-  ds,
-  map = c(parent = "Parent"),
-  links = NA,
-  filename = "CAKE_export.csf",
-  path = ".",
-  overwrite = FALSE,
-  study = "Codlemone aerobic soil degradation",
-  description = "",
-  time_unit = "days",
-  res_unit = "% AR",
-  comment = "Created using mkin::CAKE_export",
-  date = Sys.Date(),
-  optimiser = "IRLS"
-)
- -

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ds

A named list of datasets in long format as compatible with -mkinfit.

map

A character vector with CAKE compartment names (Parent, A1, ...), -named with the names used in the list of datasets.

links

An optional character vector of target compartments, named with +

+ 
CAKE_export(
+  ds,
+  map = c(parent = "Parent"),
+  links = NA,
+  filename = "CAKE_export.csf",
+  path = ".",
+  overwrite = FALSE,
+  study = "Degradinol aerobic soil degradation",
+  description = "",
+  time_unit = "days",
+  res_unit = "% AR",
+  comment = "",
+  date = Sys.Date(),
+  optimiser = "IRLS"
+)
+
+ +
+

Arguments

+
ds
+

A named list of datasets in long format as compatible with +mkinfit.

+ + +
map
+

A character vector with CAKE compartment names (Parent, A1, ...), +named with the names used in the list of datasets.

+ + +
links
+

An optional character vector of target compartments, named with the names of the source compartments. In order to make this easier, the -names are used as in the datasets supplied.

filename

Where to write the result. Should end in .csf in order to be -compatible with CAKE.

path

An optional path to the output file.

overwrite

If TRUE, existing files are overwritten.

study

The name of the study.

description

An optional description.

time_unit

The time unit for the residue data.

res_unit

The unit used for the residues.

comment

An optional comment.

date

The date of file creation.

optimiser

Can be OLS or IRLS.

- -

Value

- -

The function is called for its side effect.

-

Author

+names are used as in the datasets supplied.

+ + +
filename
+

Where to write the result. Should end in .csf in order to be +compatible with CAKE.

+ + +
path
+

An optional path to the output file.

+ + +
overwrite
+

If TRUE, existing files are overwritten.

+ + +
study
+

The name of the study.

+ + +
description
+

An optional description.

+ +
time_unit
+

The time unit for the residue data.

+ + +
res_unit
+

The unit used for the residues.

+ + +
comment
+

An optional comment.

+ + +
date
+

The date of file creation.

+ + +
optimiser
+

Can be OLS or IRLS.

+ +
+
+

Value

+ + +

The function is called for its side effect.

+
+
+

Author

Johannes Ranke

+
+
- - - + + -- cgit v1.2.1