diff options
| author | Johannes Ranke <johannes.ranke@jrwb.de> | 2025-11-28 09:20:07 +0100 |
|---|---|---|
| committer | Johannes Ranke <johannes.ranke@jrwb.de> | 2025-11-28 09:20:07 +0100 |
| commit | fe411af3dbed474d9e5b3cc1d509f66bd76f7319 (patch) | |
| tree | 8b1a3a355c0aa6e0a59ec192e315e96c99640ff2 /R/mkinds.R | |
| parent | a5a73e8d76faff5983399386de571431e8824636 (diff) | |
Example evaluation of D24_2014, improve docs
Diffstat (limited to 'R/mkinds.R')
| -rw-r--r-- | R/mkinds.R | 7 |
1 files changed, 6 insertions, 1 deletions
@@ -3,7 +3,7 @@ #' @description #' At the moment this dataset class is hardly used in mkin. For example, #' mkinfit does not take mkinds datasets as argument, but works with dataframes -#' such as the on contained in the data field of mkinds objects. Some datasets +#' such as the one contained in the data field of mkinds objects. Some datasets #' provided by this package come as mkinds objects nevertheless. #' #' @importFrom R6 R6Class @@ -87,6 +87,11 @@ print.mkinds <- function(x, data = FALSE, ...) { #' Time normalisation factors are initialised with a value of 1 for each #' dataset if no data are supplied. #' +#' @note +#' Currently, no functions making use of the defined class structure +#' are available in this package. Refer to [D24_2014] for an example +#' dataset in this structure, with some example evaluations. +#' #' @examples #' #' mdsg <- mkindsg$new("Experimental X", experimental_data_for_UBA_2019[6:10]) |
