https://github.com/mcanouil/clere

Simultaneous Variables Clustering and Regression
https://github.com/mcanouil/clere

r r-package r-stats regression-models variables-clustering

Last synced: about 2 months ago
JSON representation

Simultaneous Variables Clustering and Regression

• Host: GitHub
• URL: https://github.com/mcanouil/clere
• Owner: mcanouil
• License: gpl-3.0
• Archived: true
• Created: 2020-02-04T10:28:42.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2021-09-16T19:44:32.000Z (over 3 years ago)
• Last Synced: 2024-08-13T07:14:08.669Z (5 months ago)
• Topics: r, r-package, r-stats, regression-models, variables-clustering
• Language: R
• Homepage:
• Size: 9.7 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• jimsghstars - mcanouil/clere - Simultaneous Variables Clustering and Regression (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# clere: Simultaneous Variables Clustering and Regression

[![GitHub tag](https://img.shields.io/github/tag/mcanouil/clere.svg?label=latest tag&include_prereleases)](https://github.com/mcanouil/clere)

[![Codecov test

coverage](https://codecov.io/gh/mcanouil/clere/branch/main/graph/badge.svg)](https://codecov.io/gh/mcanouil/clere?branch=main)

[![R-CMD-check](https://github.com/mcanouil/clere/workflows/R-CMD-check/badge.svg)](https://github.com/mcanouil/clere/actions)

[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version-ago/clere)](https://cran.r-project.org/package=clere)

[![cran checks_worst](https://cranchecks.info/badges/worst/clere)](https://cran.r-project.org/web/checks/check_results_clere.html)

[![CRAN_Download_total](https://cranlogs.r-pkg.org/badges/clere)](https://cran.r-project.org/package=clere)

Implements an empirical Bayes approach for simultaneous variable clustering and regression. 

This version also (re)implements in C++ an R script proposed by Howard Bondell that fits the Pairwise Absolute Clustering and Sparsity (PACS) methodology (see Sharma et al (2013) doi: [10.1080/15533174.2012.707849](https://doi.org/10.1080/15533174.2012.707849)).

## Installation

You can install the released version of clere from [CRAN](https://CRAN.R-project.org) with:

```{r, eval = FALSE}

install.packages("clere")

```

And the development version from [GitHub](https://github.com/) with:

```{r, eval = FALSE}

# install.packages("remotes")

remotes::install_github("mcanouil/clere")

```

## Citing clere

```{r, echo = FALSE, results = "asis"}

print(citation("clere"), "html")

```

```{r, echo = FALSE, comment = ""}

print(citation("clere"), "bibtex")

```

## Example

```{r example}

library(clere)

x <- matrix(rnorm(50 * 100), nrow = 50, ncol = 100)

y <- rnorm(50)

model <- fitClere(y = y, x = x, g = 2, plotit = FALSE)

model

plot(model)

clus <- clusters(model, threshold = NULL)

clus

predict(model, newx = x + 1)

summary(model)

```

## Getting help

If you encounter a clear bug, please file a minimal reproducible example on [github](https://github.com/mcanouil/clere/issues).  

For questions and other discussion, please contact the package maintainer.

---

Please note that this project is released with a [Contributor Code of Conduct](https://github.com/mcanouil/clere/blob/main/.github/CODE_OF_CONDUCT.md).  

By participating in this project you agree to abide by its terms.