R/get_expected_params.R

In MiguelRodo/gamlsspipeline:

#' @title Print the expected parameters for each function
#'
#' @description
#' Print the names of each function along with the respective expected parameters.
#'
#' @export
get_expected_params <- function(){
  expected_params <- list("preprocess_fn" = c("data_raw", "params_dots"),
                          "plot_exp_fn" = c("data_raw", "data_mod", "dir_proj", "params_dots"),
                          'fit_fn' = c("data_mod", "params_dots", "dir_proj"),
                          'get_fit_stats_fn' = c("data_raw", "data_mod", "dir_proj",
                                                 "params_dots", "fit_obj"),
                          "plot_fit_fn" = c("data_raw", "data_mod", "dir_proj",
                                            "params_dots", "fit_obj", "fit_stats"),
                          "plot_val_fn" = c("data_raw", "data_mod", "dir_proj",
                                            "params_dots", "fit_obj"))
  expected_params
}