jaumemasip/pe-clustering-r

Prediction Explanations clustering R package

Prediction Explanation Clustering (R package)

This repository hosts the R package datarobot.pe.clustering. This package allows users of the DataRobot platform to perform dimensionality reduction and clustering on DataRobot's prediction explanations.

Usage

You can install this package using devtools::install_github() (see below) and then incorporate it into your R scripts, together with the datarobot R package and a DataRobot installation.

Once installed, view the vignette for further documentation and examples.

Repository Contents

This repository contains the package metadata, package code, unit tests, and documentation.

Setup/Installation

Installing from GitHub

The development version here can be downloaded straight from GitHub. Add in the build_vignettes flag to ensure the vignettes are built.

if (!require("devtools")) { install.packages("devtools") }
devtools::install_github("datarobot-community/pe-clustering-R", build_vignettes=TRUE)

You will need to set up a GitHub PAT token and then export GITHUB_PAT=<token> in your shell before running install_github.

To install a particular version from GitHub (or a particular branch), use @ notation in install_github, e.g. devtools::install_github("datarobot-community/[email protected]") or devtools::install_github("datarobot-community/pe-clustering-R@myAwesomeBranch").

Development and Contributing

If you'd like to report an issue or bug, suggest improvements, or contribute code to this project, please refer to CONTRIBUTING.md.

Code of Conduct

This project has adopted the Contributor Covenant for its Code of Conduct. See CODE_OF_CONDUCT.md to read it in full.

License

Licensed under the Apache License 2.0. See LICENSE to read it in full.