# CBPE <img src="man/figures/logo.png" align="right" width="25%"/>

[![R-CMD-check](https://github.com/mnrzrad/CBPE/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/mnrzrad/CBPE/actions/workflows/R-CMD-check.yaml)
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/CBPE)](https://cran.r-project.org/package=CBPE)
[![Downloads per
month](https://cranlogs.r-pkg.org/badges/CBPE)](https://cran.r-project.org/package=CBPE)
[![Total
Downloads](https://cranlogs.r-pkg.org/badges/grand-total/CBPE)](https://cran.r-project.org/package=CBPE)
[![Licence](https://img.shields.io/badge/licence-GPL--3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)

The R package *CBPE* Provides the corelation-based penalty estimators for linear and logisitic regression models.

This work is funded by national funds through the FCT - Fundação para a
Ciência e a Tecnologia, I.P., under the scope of the projects
UIDB/00297/2020 and UIDP/00297/2020 (Center for Mathematics and
Applications)".

## Installation

You can install the **stable** version from
[CRAN](https://cran.r-project.org/package=CBPE).

``` s
install.packages('CBPE', dependencies = TRUE)
```

You can install the **development** version from
[Github](https://github.com/mnrzrad/CBPE)

``` s
# install.packages("remotes")
remotes::install_github("mnrzrad/CBPE")
```

## To cite package `CBPE` in publications use:

Arashi, M., Rahimi, M., Norouzirad, M. (2024) *CBPE:
Corelation-Based Penalized Estimators*. R package version 0.1.0,
<https://cran.r-project.org/package=CBPE>.

A BibTeX entry for LaTeX users is

@Manual{CBPE, title = {CBPE: Corelation-Based Penalized Estimators},
author = {Arashi, M., Rahimi, M., Norouzirad, M.}, year = {2024}, note = {R package version 0.1.0}, url =
{<https://cran.r-project.org/package=CBPE>} }

## License

This package is free and open source software, licensed under GPL-3.
