docs/overview.md

In sahirbhatnagar/eclust: Environment Based Clustering for Interpretable Predictive Models in High Dimensional Data

Overview of Functions

This package has three sets of functions starting with either r_, s_ or u_

1. r_ (real data functions): related to analysis of real data. Most users will apply this set of functions to their data.

function.name r_cluster_data r_prepare_data

1. s_ (simulation functions): related to the simulations conducted in the paper. There are functions to simulate data, run the analyses on these data, and output performance metrics.

function.name s_generate_data s_generate_data_mars s_mars_clust s_mars_separate s_modules s_pen_clust s_pen_separate s_response s_response_mars

1. u_ (utility functions): functions that are used by both simulation and real data analysis functions. Not really meant to be called by the user.

function.name u_cluster_similarity u_extract_selected_earth u_extract_summary u_fisherZ

sahirbhatnagar/eclust documentation built on May 29, 2019, 12:58 p.m.