-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
77 lines (59 loc) · 2.3 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-"
)
palette(c("#0073C2", "#EFC000", "#868686"))
```
```{r, function_max_output_lines, include = FALSE}
library(knitr)
hook_output <- knit_hooks$get("output")
knit_hooks$set(output = function(x, options) {
lines <- options$output.lines
if (is.null(lines)) {
return(hook_output(x, options)) # pass to default hook
}
x <- unlist(strsplit(x, "\n"))
more <- "..."
if (length(lines)==1) { # first n lines
if (length(x) > lines) {
# truncate the output, but add ....
x <- c(head(x, lines), more)
}
} else {
x <- c(more, x[lines], more)
}
# paste these lines together
x <- paste(c(x, ""), collapse = "\n")
hook_output(x, options)
})
```
# 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_cran, eval=FALSE}
install.packages("clubpro")
```
Install the development version of `clubpro` from [GitHub](https://github.com/timbeechey/clubpro) with:
```{r install_github, eval=FALSE}
# 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.