R: Arena for the Exploration and Comparison of any ML Models

# Arena for the Exploration and Comparison of any ML Models

## Documentation for package ‘arenar’ version 0.2.0

- DESCRIPTION file
- User guides, package vignettes and other documentation
- Package NEWS

## Help Pages

calculate_subsets_performance | Internal function for calculating data for funnel plot
create_arena | Creates arena object
get_accumulated_dependence | Internal function for calculating Accumulated Dependence
get_attributes | Returns attributes for all params
get_break_down | Internal function for calculating Break Down
get_ceteris_paribus | Internal function for calculating Ceteris Paribus
get_datasets_list | Generates list of datasets' labels
get_dataset_attributes | Generates list with attributes of a dataset
get_dataset_plots | Internal function for calculating exploratory data anaylysis plots
get_fairness | Internal function for calculating fairness
get_feature_importance | Internal function for calculating feature importance
get_funnel_measure | Internal function for calculating funnel measure
get_global_plots | Internal function for calculating global plots
get_json_structure | Prepare object ready to change into json
get_local_plots | Internal function for calculating local plots for all observations
get_message_output | Internal function for returning message as plot data
get_metrics | Internal function for calculating model performance metrics
get_model_attributes | Generates list with attributes of a model
get_observations_list | Generates list of rownames of each observation from each batch
get_observation_attributes | Generates list with attributes of an observation
get_partial_dependence | Internal function for calculating Partial Dependence
get_rec | Internal function for calculating regression error characteristic
get_roc | Internal function for calculating receiver operating curve
get_shap_values | Internal function for calculating Shapley Values
get_subsets_performance | Internal function for calculating subset performance
get_variables_list | Generates list of unique variables(without target) from each explainer and dataset
get_variable_against_another | Internal function for variable against another plot
get_variable_attributes | Generates list with attributes of an variable
get_variable_distribution | Internal function for variable distribution
print.arena_live | Prints live arena summary
print.arena_static | Prints static arena summary
push_dataset | Adds new datasets to Arena
push_model | Adds model to arena
push_observations | Adds new observations to arena
run_server | Run server providing data for live Arena
save_arena | Save generated json file from static arena
split_multiclass_explainer | Splits multiclass explainer into multiple classification explainers
truncate_vector | Internal function for pretty truncationg params list
upload_arena | Upload generated json file from static arena
validate_new_dataset | Checks if it is safe do add new dataset to the arena object
validate_new_model | Checks if it is safe do add a new model to the arena object
validate_new_observations | Checks if it is safe do add new observations to the arena object