-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
89 lines (66 loc) · 2.49 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
78
79
80
81
82
83
84
85
86
87
88
89
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# edmcore
<!-- badges: start -->
[![R build status](/~https://github.com/tmsalab/edmcore/workflows/R-CMD-check/badge.svg)](/~https://github.com/tmsalab/edmcore/actions)
[![Package-License](http://img.shields.io/badge/license-GPL%20\(%3E=2\)-brightgreen.svg?style=flat)](http://www.gnu.org/licenses/gpl-2.0.html)
[![Codecov test coverage](https://codecov.io/gh/tmsalab/edmcore/branch/master/graph/badge.svg)](https://codecov.io/gh/tmsalab/edmcore?branch=master)
<!-- badges: end -->
The goal of `edmcore` is to house a set of functions shared by many packages
within the exploratory cognitive diagnostic modeling framework.
## Installation
You can install the released version of edmcore from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("edmcore")
```
And the development version from [GitHub](/~https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("tmsalab/edmcore")
```
## Usage
To use `edmcore`, load the package using:
``` r
library("edmcore")
```
## Overview
The package contains class structure shared between different estimation
units.
In particular, we have:
- EDM Classes
- `new_edm_model()`, `new_edm_summary()`, and `new_edm_default_property_list()`.
- Attributes
- `attribute_classes()`, `attribute_bijection()`, `attribute_inv_bijection()`, `attribute_gen_bijection()`, and `attribute_inv_gen_bijection()`.
- Q Matrix
- `q_matrix()`/`as_q_matrix()`, `read_q_matrix()`, `is_q_matrix()`, `is_q_strict()`, and
`is_q_generic()`.
- Item Matrix
- `item_matrix()`/`as_item_matrix()`, `read_item_matrix()`, and `is_item_matrix()`.
- Metrics
- `metric_mode()`, `metric_bias()`, `metric_frobenius_norm()`, `metric_element_wise()`, and
`metric_matrix_wise()`.
- Permutations
- Link Functions
- `link_probit()`, `link_probit_inv()`, `link_logit()`, `link_logit_inv()`,
`theta_to_beta()`, `theta_probit_to_beta()`, and `theta_logit_to_beta()`.
## Authors
James Joseph Balamuta, Steven Andrew Culpepper, and Jeffrey Douglas
## Citing the `edmcore` package
To ensure future development of the package, please cite `edmcore`
package if used during the analysis or simulations. Citation information
for the package may be acquired by using in *R*:
``` r
citation("edmcore")
```
## License
GPL (\>= 2)