validate_user_input: Validate User Input for FaaS modeling

View source: R/validate_user_input.R

validate_user_inputR Documentation

Validate User Input for FaaS modeling

Description

This function will perform an initial check if all necessary arguments to run the run_models were provided.

Usage

validate_user_input(
  data_list,
  date_variable,
  date_format,
  model_spec,
  project_name,
  user_email,
  user_model,
  skip_validation
)

Arguments

data_list

list with datasets to be modeled, where the list elements must be named after the dependent variable. You cannot have more than one dependent variable with same name in a data_list.

date_variable

name of variable with date information in all datasets in data_list.

date_format

format of date_variable in all datasets in data_list.

model_spec

list with modeling and cross validation setup.

project_name

project name. A string with character and/or numeric inputs that should be at most 50 characters long. Special characters will be removed.

user_email

email to receive the outputs.

user_model

list containing the models constraints to create a model customized by the user.

skip_validation

TRUE or FALSE, indicating if validation should be skipped.

Details

DETAILS

Value

None. Will break if any argument is not properly defined.

Examples

## Not run: 
if(interactive()){
 #EXAMPLE1
 }

## End(Not run)

4intelligence/faas4i documentation built on April 14, 2025, 2:09 a.m.