is_gcae_experiment_params: Determine if the 'gcae_experiment_params' is indeed a...
In richelbilderbeek/gcaer: Interface to GCAE

View source: R/is_gcae_experiment_params.R

is_gcae_experiment_params

R Documentation

Determine if the `gcae_experiment_params` is indeed a `gcae_experiment_params`

Description

Determine if the gcae_experiment_params is indeed a gcae_experiment_params

Usage

is_gcae_experiment_params(gcae_experiment_params, verbose = FALSE)

Arguments

`gcae_experiment_params`	parameters to run a full `GCAE` experimenr (i.e. call do_gcae_experiment), as created by create_gcae_experiment_params and checked by check_gcae_experiment_params
`verbose`	the verbosity of a function. Set to TRUE for more output. Use check_verbose to detect if this argument is valid.

Value

TRUE if the gcae_experiment_params is indeed a gcae_experiment_params

Author(s)

Richèl J.C. Bilderbeek

Examples

# TRUE
is_gcae_experiment_params(create_test_gcae_experiment_params())

# FALSE
is_gcae_experiment_params(gcae_experiment_params = "nonsense")
is_gcae_experiment_params("nonsense", verbose = TRUE)

richelbilderbeek/gcaer documentation built on March 25, 2024, 3:08 p.m.