-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathREADME.Rmd
More file actions
52 lines (34 loc) · 2.56 KB
/
README.Rmd
File metadata and controls
52 lines (34 loc) · 2.56 KB
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
---
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-"
)
version <- as.character(packageVersion("tbltools"))
```
# tbltools
<!-- badges: start -->
[](https://github.com/KopfLab/tbltools/actions/workflows/R-CMD-check.yaml)
[](https://kopflab.github.io/tbltools/reference/)
<!-- badges: end -->
## About
The [tbltools](https://kopflab.github.io/tbltools/) package is a collection of tools for team-based-learning (TBL) style flipped classrooms.
## Installation
You can install [tbltools](https://kopflab.github.io/tbltools/) from github with the devtools package. If you do not already have many of the dependencies installed, this may take a moment.
```{r gh-installation, eval = FALSE}
# install.packages("devtools")
devtools::install_github("KopfLab/tbltools")
```
## Functionality
### iRAT/tRAT Generation
The [tbltools](https://kopflab.github.io/tbltools/) package provides functionality to easily generate Readiness Assessment Tests from a collection of questions and answers (including images and equations) and any IF-AT answer key. For an example of how to use this functionality, see the vignette on [Generating a Readiness Assessment Test](https://kopflab.github.io/tbltools/articles/assessment_tests.html).
### Peer Evaluations
The [tbltools](https://kopflab.github.io/tbltools/) package also provides functionality to easily set up a peer evaluation server based on a student roster and team assignments and then evaluate the collected data. For an example of how to use this functionality, see the vignette on [Peer Evaluations](https://kopflab.github.io/tbltools/articles/peer_evaluations.html).
### Other functionality?
Ideas or suggestions for additional tools that would be helpful for running a flipped classroom? Let us know by filing a feature request at https://github.com/kopflab/tbltools/issues.
## Open Source
This package is and will always be fully open-source (i.e. free as in 'freedom' and free as in 'free beer') and is provided as is. The source code is released under GPL-2. We welcome participation in this project in all forms from user feedback and bug reports to feature requests and coding contributions. This project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.