-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.Rmd
87 lines (63 loc) · 2.89 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
# simcdm
<!-- badges: start -->
[![R-CMD-check](https://github.com/tmsalab/simcdm/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/tmsalab/simcdm/actions/workflows/R-CMD-check.yaml)
[![Package-License](https://img.shields.io/badge/license-GPL%20(%3E=2)-brightgreen.svg?style=flat)](https://www.gnu.org/licenses/gpl-2.0.html)
[![CRAN Version Badge](https://www.r-pkg.org/badges/version/simcdm)](https://cran.r-project.org/package=simcdm)
[![CRAN Status](https://badges.cranchecks.info/worst/simcdm.svg)](https://cran.r-project.org/web/checks/check_results_simcdm.html)
[![RStudio CRAN Mirror's Monthly Downloads](https://cranlogs.r-pkg.org/badges/simcdm?color=brightgreen)](https://www.r-pkg.org/pkg/simcdm)
[![RStudio CRAN Mirror's Total Downloads](https://cranlogs.r-pkg.org/badges/grand-total/simcdm?color=brightgreen)](https://www.r-pkg.org/pkg/simcdm)
<!-- badges: end -->
The goal of `simcdm` is to provide flexible ways to simulate data under
cognitive diagnostic models.
## Installation
You can install `simcdm` from GitHub with:
```{r}
#| label: gh-installation
#| eval: false
# install.packages("remotes")
remotes::install_github("tmsalab/simcdm")
```
## Usage
To use `simcdm`, load the package using:
```{r}
#| label: example
#| eval: false
library("simcdm")
```
## Overview
There are four distinct sets of functions within the package:
- Attributes: `attribute_classes()`, `attribute_bijection()`, `attribute_inv_bijection()`, and `sim_subject_attributes()`.
- Matrix: `sim_q_matrix()` and `sim_eta_matrix()`
- Deterministic Input, Noisy And Gate (DINA): `sim_dina_items()` and `sim_dina_attributes()`
- reduced Reparameterized Unified Model (rRUM): `sim_rrum_items()`
Functions that use random numbers to simulate values are named with the prefix of
`sim_*()`. This is done to allow for functions to be quickly identified and used
through autocomplete inside of the [RStudio IDE](https://posit.co/products/open-source/rstudio/) or
[VS Code](https://code.visualstudio.com/). At a later time, the `attribute_*()`
will likely be moved to a different package.
For more details, please see the [package vignettes](vignettes/):
- [Overview of `simcdm`](https://tmsalab.github.io/simcdm/articles/overview-simcdm.html)
- [Using `simcdm` in R packages](https://tmsalab.github.io/simcdm/articles/simcdm-in-packages.html)
## Authors
James Joseph Balamuta and Steven Andrew Culpepper
with contributions from Aaron Hudson.
## Citing the simcdm package
To ensure future development of the package, please cite `simcdm` package if
used during the analysis or simulations. Citation information for the package
may be acquired by using in _R_:
```{r, eval = FALSE}
citation("simcdm")
```
## License
GPL (>= 2)