From a77a10ea6c607346778ba0700b3b66ac393101a2 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Wed, 27 May 2020 06:06:08 +0200 Subject: Create up to date pkgdown docs in development mode --- docs/dev/reference/CAKE_export.html | 261 ++++++++++++++++++++++++++++++++++++ 1 file changed, 261 insertions(+) create mode 100644 docs/dev/reference/CAKE_export.html (limited to 'docs/dev/reference/CAKE_export.html') diff --git a/docs/dev/reference/CAKE_export.html b/docs/dev/reference/CAKE_export.html new file mode 100644 index 00000000..ce8a3444 --- /dev/null +++ b/docs/dev/reference/CAKE_export.html @@ -0,0 +1,261 @@ + + + + + + + + +Export a list of datasets format to a CAKE study file — CAKE_export • mkin + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + +
+ +
+
+ + +
+

In addition to the datasets, the pathways in the degradation model can be +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 +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.

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