From 91a5834dd701211f929fd25419dc34561ce3b4e7 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 14 Feb 2025 09:15:20 +0100 Subject: Initialize dev docs --- docs/dev/reference/CAKE_export.html | 178 ++++++++++++++++++++++++++++++++++++ 1 file changed, 178 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..026bc3da --- /dev/null +++ b/docs/dev/reference/CAKE_export.html @@ -0,0 +1,178 @@ + +Export a list of datasets format to a CAKE study file — CAKE_export • mkin + Skip to contents + + +
+
+
+ +

Export a list of datasets format to a CAKE study file

+ Source: R/CAKE_export.R +
CAKE_export.Rd
+
+ +
+

In addition to the datasets, the pathways in the degradation model can be +specified as well.

+
+ +
+

Usage

+ 
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.

+ + + +

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

+

Johannes Ranke

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