
<!-- README.md is generated from README.Rmd. Please edit that file -->

# clubpro

<!-- badges: start -->

![](https://www.r-pkg.org/badges/version-ago/clubpro?color=orange)
![](https://cranlogs.r-pkg.org/badges/grand-total/clubpro)
[![R-CMD-check](https://github.com/timbeechey/clubpro/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/timbeechey/clubpro/actions/workflows/R-CMD-check.yaml)
[![Codecov test
coverage](https://codecov.io/gh/timbeechey/clubpro/branch/master/graph/badge.svg)](https://app.codecov.io/gh/timbeechey/clubpro?branch=master)
<!-- badges: end -->

An R package for *cl*assification *u*sing *b*inary *p*rocrustes
*ro*tation based on Grice (2011).

## Installation

`clubpro` can be installed from CRAN:

``` r
install.packages("clubpro")
```

Install the development version of `clubpro` from
[GitHub](https://github.com/timbeechey/clubpro) with:

``` r
# install.packages("remotes")
remotes::install_github("timbeechey/clubpro")
```

## Background

`clubpro` is an implementation of a subset of the methods described in
[Grice (2011)](https://psycnet.apa.org/record/2011-14580-000).

## Using `clubpro`

See the [introductory
guide](https://timbeechey.github.io/clubpro/articles/clubpro.html) for a
brief demonstration of how to conduct a classification analysis using
`clubpro`.

# References

Grice, J. W. (2011). *Observation oriented modeling: Analysis of cause
in the behavioral sciences*. Academic Press.
