From 6476f5f49b373cd4cf05f2e73389df83e437d597 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Thu, 13 Feb 2025 16:30:31 +0100 Subject: Axis legend formatting, update vignettes --- docs/dev/reference/read_spreadsheet.html | 196 ------------------------------- 1 file changed, 196 deletions(-) delete mode 100644 docs/dev/reference/read_spreadsheet.html (limited to 'docs/dev/reference/read_spreadsheet.html') diff --git a/docs/dev/reference/read_spreadsheet.html b/docs/dev/reference/read_spreadsheet.html deleted file mode 100644 index 6e7203f4..00000000 --- a/docs/dev/reference/read_spreadsheet.html +++ /dev/null @@ -1,196 +0,0 @@ - -Read datasets and relevant meta information from a spreadsheet file — read_spreadsheet • mkin - - -
-
- - - -
-
- - -
-

This function imports one dataset from each sheet of a spreadsheet file. -These sheets are selected based on the contents of a sheet 'Datasets', with -a column called 'Dataset Number', containing numbers identifying the dataset -sheets to be read in. In the second column there must be a grouping -variable, which will often be named 'Soil'. Optionally, time normalization -factors can be given in columns named 'Temperature' and 'Moisture'.

-
- -
-
read_spreadsheet(
-  path,
-  valid_datasets = "all",
-  parent_only = FALSE,
-  normalize = TRUE
-)
-
- -
-

Arguments

-
path
-

Absolute or relative path to the spreadsheet file

- - -
valid_datasets
-

Optional numeric index of the valid datasets, default is -to use all datasets

- - -
parent_only
-

Should only the parent data be used?

- - -
normalize
-

Should the time scale be normalized using temperature -and moisture normalisation factors in the sheet 'Datasets'?

- -
-
-

Details

-

There must be a sheet 'Compounds', with columns 'Name' and 'Acronym'. -The first row read after the header read in from this sheet is assumed -to contain name and acronym of the parent compound.

-

The dataset sheets should be named using the dataset numbers read in from -the 'Datasets' sheet, i.e. '1', '2', ... . In each dataset sheet, name -of the observed variable (e.g. the acronym of the parent compound or -one of its transformation products) should be in the first column, -the time values should be in the second colum, and the observed value -in the third column.

-

In case relevant covariate data are available, they should be given -in a sheet 'Covariates', containing one line for each value of the grouping -variable specified in 'Datasets'. These values should be in the first -column and the column must have the same name as the second column in -'Datasets'. Covariates will be read in from columns four and higher. -Their names should preferably not contain special characters like spaces, -so they can be easily used for specifying covariate models.

-

An similar data structure is defined as the R6 class mkindsg, but -is probably more complicated to use.

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