Bump Hunting by Patient Rule Induction Method for Survival, Regression and Classification
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
R
data
inst
man
src
.Rbuildignore
.gitignore
.travis.yml
DESCRIPTION
LICENSE
NAMESPACE
README.md

README.md

PRIMsrc

Bump Hunting by Patient Rule Induction Method for Survival, Regression, and Classification

===============

Description

"Bump Hunting" (BH) refers to the procedure of mapping out a local region of the multi-dimensional input space where a target function of interest, usually unknown, assumes smaller or larger values than its average over the entire space. In general, the region R could be any smooth shape (e.g. a convex hull) possibly disjoint.

PRIMsrc implements a unified treatment of "Bump Hunting" (BH) by Patient Rule Induction Method (PRIM) with Survival, Regression and Classification outcomes (SRC). To estimate the region, PRIM generates decision rules delineating hyperdimensional boxes (hyperrectangles) of the input space, not necessarily contiguous, where the outcome is smaller or larger than its average over the entire space.

Assumptions are that the multivariate input variables can be discrete or continuous, and the univariate outcome variable can be discrete (Classification), continuous (Regression), or a time-to-event, possibly censored (Survival). It is intended to handle low and high-dimensional multivariate datasets, including the paradigm where the number of covariates (p) exceeds or dominates that of samples (n): p > n or p >> n.

Please note that the current version (0.8.1) is a development release that only implements the case of a survival outcome. At this point, this version of PRIMsrc is also restricted to a directed peeling search of the first box covered by the recursive coverage (outer) loop of our Patient Recursive Survival Peeling (PRSP) algorithm (Dazard et al., 2014, 2015, 2016, 2018). New features will be added as soon as available.

===============

Details

In a direct application, "Bump Hunting" (BH) can identify subgroups of observations for which their outcome is as extreme as possible. Similarly to this traditional goal of subgroup finding, PRIMsrc also implements the alternative goal of mapping out a region (possibly disjointed) of the input space where the outcome difference between existing (fixed) groups of observations is as extreme as possible. We refer to the later goal as "Group Bump Hunting" (GBH).

In the case of a time-to event, possibly censored (Survival) outcome, "Survival Bump Hunting" (SBH) is done by our Patient Recursive Survival Peeling (PRSP) algorithm (see Dazard et al. (2014, 2015, 2016, 2018) for details). Alternatively, "Group Survival Bump Hunting" (GSBH) is done by using specifc peeling and cross-validation criterion in a derivation of PRSP, which we call Patient Recursive Group Survival Peeling (PRGSP) (see Rao et al. (2018) for details and an application in Survival Disparity Subtyping).

The package relies on an optional variable screening (pre-selection) procedure that is run before the PRSP algorithm and final variable usage (selection) procedure is done. This is done by four possible cross-validated variable screening (pre-selection) procedures offered to the user from the main end-user survival Bump Hunting function sbh() (see Dazard et al. (2018) for details). At this point, the user can choose between:

  • Univariate Patient Recursive Survival Peeling algorithm (default of package PRIMsrc)
  • Penalized Censored Quantile Regression (by Semismooth Newton Coordinate Descent algorithm adapted from package hqreg)
  • Penalized Partial Likelihood (adapted from package glmnet)
  • Supervised Principal Component Analysis (adapted from package superpc)

In this version, the Cross-Validation (CV) procedure and Bump Hunting procedures that control model size (#covariates) and model complexity (#peeling steps), respectively, to fit the Survival Bump Hunting model, are carried out internally by two consecutive tasks within a single main end-user survival Bump Hunting function sbh(). The returned S3-class sbh object contains cross-validated estimates of all the decision-rules of used covariates and all other statistical quantities of interest at each iteration of the peeling sequence (inner loop of the PRSP algorithm). This enables the graphical display of results of profiling curves for model selection/tuning, peeling trajectories, covariate traces and survival distributions (Dazard et al., 2014, 2015, 2016, 2018).

The package PRIMsrc offers a number of options for the number of replications of the fitting procedure to be perfomed: B; the type of K-fold cross-validation desired: (replicated)-averaged or-combined; as well as the peeling and cross-validation critera for model selection/tuning, and a few more parameters for the PRSP algorithm. The package takes advantage of the R packages parallel and snow, which allows users to create a parallel backend within an R session, enabling access to a cluster of compute cores and/or nodes on a local and/or remote machine(s) with either. The package supports two types of communication mechanisms between master and worker processes: 'Socket' or 'Message-Passing Interface' ('MPI').

============

Branches

This branch (master) is the default one, that hosts the current development release (version 0.8.1) of the "Survival Bump Hunting" (SBH) (or "Group Survival Bump Hunting" (GSBH)) procedure. Note that PRIMsrc is still a non-production release and that version 0.8.1 implements significant user-visible changes. Check details of new features, changes, and bug fixes in the "Usage" section below.

The second branch (unified) will host the future complete version of the code (version 1.0.0), including undirected peeling search derived from the Patient Rule Induction Method (PRIM), and unified treatment of bump hunting for every type of common outcome: Survival, Regression, and Classification (SRC).

===========

License

PRIMsrc is open source / free software, licensed under the GNU General Public License version 3 (GPLv3), sponsored by the Free Software Foundation. To view a copy of this license, visit GNU Free Documentation License.

=============

Downloads

CRAN downloads since initial release to CRAN (2015-07-28): as tracked by RStudio CRAN mirror

CRAN downloads in the last month:

CRAN downloads in the last week:

================

Requirements

PRIMsrc (>= 0.8.1) requires R-3.0.2 (2013-09-25). It was built and tested under R version 3.5.1 (2018-07-02) and Travis CI.

Installation has been tested on Windows, Linux, OSX and Solaris platforms.

See Travis CI build result: Build Status

See CRAN checks: CRAN_Status_Badge.

================

Installation

  • To install the stable version (0.8.1) of PRIMsrc from the CRAN repository, simply download and install the current version (0.8.1) from the CRAN repository:
install.packages("PRIMsrc")
  • Alternatively, you can install the most up-to-date development version (>= 0.8.1) of PRIMsrc from the GitHub repository, simply run the following using devtools:
install.packages("devtools")
library("devtools")
devtools::install_github("jedazard/PRIMsrc")

=========

Usage

  • To load the PRIMsrc library in an R session and start using it:
library("PRIMsrc")
  • Check details of new features, changes, and bug fixes with the following R command:
PRIMsrc.news()
  • Check on how to cite the package with the R command:
citation("PRIMsrc")

etc...

==================

Website - Wiki

  • See Project Website for General Remarks, Goal and Why Use PRIMsrc.
  • See Project Wiki for Roadmap, Documentation and Examples, Publications, Case Studies, Support and How to contribute (code and documentation).

===================

Acknowledgments

Authors:

Maintainers:

Funding/Provision/Help:

  • This work made use of the High Performance Computing Resource in the Core Facility for Advanced Research Computing at Case Western Reserve University.
  • This project was partially funded by the National Institutes of Health NIH - National Cancer Institute (R01-CA160593) to J-E. Dazard and J.S. Rao.

==============

References

  • Dazard J-E. and Rao J.S. Variable Selection Strategies for High-Dimensional Survival Bump Hunting using Recursive Peeling Methods. [2018 (in prep)].

  • Diaz D.A., Saenz J.P., Dazard J-E. and Rao J.S. Mode Hunting through Active Information. Applied Stochastic Models in Business and Industry (2018), in press.

  • Diaz D.A., Dazard J-E. and Rao J.S. Unsupervised Bump Hunting Using Principal Components. In: Ahmed SE, editor. Big and Complex Data Analysis: Methodologies and Applications. Contributions to Statistics, vol. Edited Refereed Volume. Springer International Publishing, Cham Switzerland (2017), 325-345.

  • Yi C. and Huang J. Semismooth Newton Coordinate Descent Algorithm for Elastic-Net Penalized Huber Loss Regression and Quantile Regression. J. Comp Graph. Statistics (2017), 26(3):547-557.

  • Dazard J-E., Choe M., LeBlanc M. and Rao J.S. Cross-validation and Peeling Strategies for Survival Bump Hunting using Recursive Peeling Methods. Statistical Analysis and Data Mining (2016), 9(1):12-42. (The American Statistical Association Data Science Journal)

  • Dazard J-E., Choe M., LeBlanc M. and Rao J.S. R package PRIMsrc: Bump Hunting by Patient Rule Induction Method for Survival, Regression and Classification. In JSM Proceedings, Statistical Programmers and Analysts Section. Seattle, WA, USA. American Statistical Association IMS - JSM, p. 650-664. JSM (2015).

  • Dazard J-E., Choe M., LeBlanc M. and Rao J.S. Cross-Validation of Survival Bump Hunting by Recursive Peeling Methods. In JSM Proceedings, Survival Methods for Risk Estimation/Prediction Section. Boston, MA, USA. American Statistical Association IMS - JSM, p. 3366-3380. JSM (2014).

  • Dazard J-E. and J.S. Rao. Local Sparse Bump Hunting. J. Comp Graph. Statistics (2010), 19(4):900-92.