R/datasets.R

In KWB-R/kwb.qmra: QMRA (quantitative microbial risk assessment)

#' config_dummy_json: dummy configuration for kwb.qmra::opencpu_simulate_risk() in JSON format
#'
#' @description  JSON input configuration generated with R script (data-raw/config_json.R)
#' @docType data
#'
#' @usage data(config_dummy_json)
#'
#' @format  A json list with all configuration parameters used by \link{opencpu_simulate_risk},
#' which are  passed to {simulate_risk}
#'
#' @keywords datasets
#' @examples
#' data("config_dummy_json")
#' config_dummy_json
#'

"config_default_json"


#' config_default_json: default configuration developed by Christoph Sprenger 
#' for kwb.qmra::opencpu_simulate_risk() in JSON format
#'
#' @description  JSON input configuration generated with R script (data-raw/config_json.R)
#' @docType data
#'
#' @usage data(config_default_json)
#'
#' @format  A json list with all configuration parameters used by \link{opencpu_simulate_risk},
#' which are  passed to {simulate_risk}
#'
#' @keywords datasets
#' @examples
#' data("config_default_json")
#' config_default_json
#'

"config_dummy_json"

#' risk_dummy_json: example risk_json object returned by kwb.qmra::opencpu_simulate_risk()
#'
#' @description  JSON risk result object generated with R script (data-raw/risk_json.R)
#' @docType data
#'
#' @usage data(risk_dummy_json)
#'
#' @format  A json list with all risk results generated by \link{opencpu_simulate_risk},
#' using the dataset `config_dummy_json` 
#'
#' @keywords datasets
#' @examples
#' data("risk_dummy_json")
#' risk <- jsonlite::fromJSON(risk_dummy_json)
#' ### only show "stats" elements (skip "events" and "total" due to much data)
#' risk_stats <- list(stats_total = risk$stats_total,
#'                    stats_logremoval = risk$stats_logremoval)
#' jsonlite::toJSON(risk_stats, pretty = TRUE)

"risk_dummy_json"