check_gcae_experiment_params: Check if the options to run GCAE are valid.

View source: R/check_gcae_experiment_params.R

check_gcae_experiment_paramsR Documentation

Check if the options to run GCAE are valid.

Description

Check if the options to run GCAE are valid. Will stop if not.

Usage

check_gcae_experiment_params(gcae_experiment_params)

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

Details

Note that this function does not check if GCAE is actually present in that folder, similar to normalizePath with mustWork set to FALSE

Value

the GCAE options, as can be checked by check_gcae_experiment_params

Author(s)

Richèl J.C. Bilderbeek

Examples

gcae_experiment_params <- create_gcae_experiment_params(
  gcae_options = create_gcae_options(),
  gcae_setup = create_test_gcae_setup(),
  analyse_epochs = seq(1, 2, 3),
  metrics = "f1_score_3,f1_score_5"
)
check_gcae_experiment_params(gcae_experiment_params)

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