Man pages for Yu-Group/simChef
Intensive Computational Experiments Made Easy
| abort | Signals an error with default subclass "simChef_error". |
| abort_if_missing_subclass | Check an object for a subclass and signal an error if the... |
| abort_on_invalid_user_action | Constructs a helpful message and signals an error when the... |
| add_funs | Helper functions for adding components to an 'Experiment'. |
| add_na_counts | Developer function to add number of NAs to evaluator results |
| check_equal | Check equality of 'Experiment' components. |
| check_results_names | Helper function to throw informative error when column names... |
| class_metric_vec_constructor | Helper function for constructing 'metric_vec' methods for... |
| clear_cache | Clear cached results from 'Experiment'. |
| compare_tibble_rows | Compare two tibbles. |
| compute_dgp | Distribute simulation computation by DGPs. |
| compute_dgp_method | Doubly nested distributed simulation computation nested by... |
| compute_dgp_method_reps | Triply nested distributed simulation computation nested by... |
| compute_dgp_rep | Doubly nested distributed simulation computation nested by... |
| compute_method | Distribute simulation computation by Methods. |
| compute_method_rep | Doubly nested distributed simulation computation nested by... |
| compute_rep | Distribute simulation computation by replicates. |
| create_assign_str | Create an assignment string and print to console. |
| create_dgp | Create a new 'DGP' (data-generating process) |
| create_doc_template | Initialize documentation template for the R Markdown results... |
| create_evaluator | Create a new 'Evaluator' |
| create_experiment | Create a new 'Experiment'. |
| create_fun_str | Create a function call string and print to console. |
| create_list_args_str | Create a string with list arguments |
| create_method | Create a new 'Method' |
| create_rmd | Render an R Markdown file summarizing the results of an... |
| create_visualizer | Create a new 'Visualizer' |
| DGP | 'R6' class representing a data-generating process |
| do_call_handler | Call a function with given parameters and capture errors,... |
| eval_constructor | Developer function to construct basic Evaluator. |
| eval_feature_importance_funs | Evaluate and/or summarize feature importance scores. |
| eval_feature_selection_curve_funs | Evaluate and/or summarize ROC or PR curves for feature... |
| eval_feature_selection_err_funs | Evaluate and/or summarize feature selection errors. |
| eval_pred_curve_funs | Evaluate and/or summarize ROC or PR curves. |
| eval_pred_err_funs | Evaluate and/or summarize prediction errors. |
| eval_reject_prob | Evaluate the rejection probability of a hypothesis test. |
| eval_summarizer | Developer function for summarizing evaluation results. |
| eval_testing_curve_funs | Evaluate and/or summarize ROC or PR curves for feature... |
| eval_testing_err_funs | Evaluate and/or summarize error metrics when conducting... |
| evaluate_experiment | Evaluate an 'Experiment'. |
| Evaluator | 'R6' class representing an evaluator |
| event_col | Logic for 'event_level' in custom 'yardstick' metrics. |
| Experiment | 'R6' class representing a simulation experiment. |
| export_visualizers | Export cached 'Visualizer' results to image. |
| finalize_estimator_internal_constructor | Helper function for constructing... |
| fit_experiment | Fit an 'Experiment'. |
| fix_duplicate_param_names | Fix duplicate 'vary_across' parameter names. |
| fp | Number of false positives |
| generate_data | Generate data from each 'DGP' in the 'Experiment'. |
| get_cached_results | Retrieve cached results from previously saved 'Experiment'. |
| get_dot_args | Get dot (...) arguments. |
| get_funs | Helper functions for getting components in an 'Experiment'. |
| get_matching_rows | Get matching rows from x based on id |
| get_plot_data | Developer function to get data for plotting in Visualizers. |
| get_save_dir | Get results directory for an 'Experiment'. |
| HTML | Mark Characters as HTML |
| inform | Signals a message with default subclass "simChef_message". |
| init_docs | Initialize documentation template for the R Markdown results... |
| init_sim_project | Create a simulation project |
| library_templates | Functions to create boilerplate code for specific types of... |
| list_col_to_chr | Convert a list column to a readable character column. |
| list_to_tibble | Coerce list into a tibble. |
| list_to_tibble_row | Coerce list into a tibble row. |
| load_all | Load All Simulation Functions in R/ |
| maybe_get_vary_params_col | Convert '.vary_params' keyword to plotting variable in data |
| Method | 'R6' class representing a method |
| neg | Number of estimated negative cases |
| obj_size | Get the size of an object, including environments. |
| paste_md | Read Markdown file into R Markdown. |
| pipe_value | Find last non-comment line, add a |> to the end, then add... |
| plot_eval_constructor | Developer function for plotting results from Evaluator. |
| plot_feature_importance | Plot feature importances. |
| plot_feature_selection_curve | Plot ROC/PR curves for feature selection. |
| plot_feature_selection_err | Plot feature selection error according to various metrics. |
| plot_fit_constructor | Developer function for plotting results from particular... |
| plot_pred_curve | Plot ROC/PR curves. |
| plot_pred_err | Plot prediction error according to various metrics. |
| plot_reject_prob | Plot the rejection probability of a hypothesis test. |
| plot_testing_curve | Plot ROC/PR curves for feature rankings, ranked by p-values. |
| plot_testing_err | Plot testing error evaluation results according to various... |
| pos | Number of estimated positive cases |
| remove_funs | Helper functions for removing components of an 'Experiment'. |
| remove_source | Remove source code from functions. |
| render_docs | Render an R Markdown file summarizing the results of an... |
| rescale_curve | Rescale ROC/PR curves onto the same x-axis grid |
| run_experiment | Run the full 'Experiment' pipeline (fitting, evaluating, and... |
| run_tests | Run Tests |
| save_experiment | Save an 'Experiment'. |
| set_doc_options | Set R Markdown options for 'Evaluator' and 'Visualizer'... |
| set_export_viz_options | Set 'ggplot2::ggsave' export options for a 'Visualizer'. |
| set_rmd_options | Set R Markdown options for 'Evaluator' and 'Visualizer'... |
| set_save_dir | Set results directory for an 'Experiment'. |
| shared_error_args | Arguments that are shared by multiple signal functions. |
| shared_eval_lib_args | Arguments that are shared by multiple 'Evaluator' library... |
| shared_experiment_helpers_args | Arguments that are shared by multiple Experiment helper funs. |
| shared_viz_lib_args | Arguments that are shared by multiple 'Visualizer' library... |
| simplify_tibble | Simplify tibble. |
| test_sim_dir | Test simChef Ingredients |
| tp | Number of true positives |
| update_funs | Helper functions for updating components of an 'Experiment'. |
| use_dgp_template | Function to create boilerplate code for creating DGPs. |
| use_evaluator_template | Function to create boilerplate code for creating Evaluators. |
| use_experiment_template | Function to create boilerplate code for creating Experiments. |
| use_init_docs_template | Function to create boilerplate code for creating the... |
| use_library_template | Function to create boilerplate code for loading in packages |
| use_method_template | Function to create boilerplate code for creating Methods. |
| use_render_docs_template | Function to create boilerplate code for creating the Rmd... |
| use_run_template | Function to create boilerplate code for running an... |
| use_variable_template | Function to create boilerplate code for assigning descriptive... |
| use_visualizer_template | Function to create boilerplate code for creating Visualizers |
| vary_across | Varying across parameters in an 'Experiment'. |
| visualize_experiment | Visualize results of an 'Experiment'. |
| Visualizer | 'R6' class representing a visualizer |
| warn | Signals a warning with default subclass "simChef_warning". |
