From 2bb59c88d49b193f278916ad9cc4de83c0de9604 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Wed, 2 Mar 2022 18:03:54 +0100 Subject: Make tests more platform independent, update docs --- docs/reference/CAKE_export.html | 251 +++++++++++++--------------------------- 1 file changed, 81 insertions(+), 170 deletions(-) (limited to 'docs/reference/CAKE_export.html') diff --git a/docs/reference/CAKE_export.html b/docs/reference/CAKE_export.html index 05cd04a7..d36f5ed9 100644 --- a/docs/reference/CAKE_export.html +++ b/docs/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 - - + + - - -
-
- -
- -
+
@@ -149,116 +88,88 @@ 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"
-)
+
+
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 +

+

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

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

- +
+
+

Author

Johannes Ranke

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