This repository has been archived by the owner on Dec 30, 2023. It is now read-only.
forked from mattansb/cheatR
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
53 lines (35 loc) · 1.44 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
---
output: github_document
---
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE, fig.path = "doc/")
options(knitr.kable.NA = '', digits = 3)
library(ggplot2)
theme_set(theme_void())
```
<!-- README.md is generated from README.Rmd. Please edit that file -->
# cheatR: Catch 'em baddies <img src="doc\cheatRball.png" align="right" height="345" width="300"/>
This is a mini package to help you find cheaters by comparing hand-ins!
([Read more](https://shouldbewriting.netlify.com/posts/2018-07-29-cheatr/) about the circumstances that brought about the development of this package.)
## Download and Install
You can install `cheatR` from [github](https://github.com/mattansb/cheatR) with:
```R
# install.packages("devtools")
devtools::install_github("mattansb/cheatR")
```
## Example usage
<!-- generated from the vignette. Please see that file -->
```{r child = 'vignettes/using-cheatR.Rmd'}
```
### Shiny app!
The accompanying `Shiny` app can be found on [shinyapps.io](https://almogsi.shinyapps.io/cheatR/), but can also be run locally with:
```R
cheatR::catch_em_app()
```
<img src="doc\shiny_app.PNG" align="center"/>
## Limitations?
- As far as we can tell, this should work on any language; we tried both English and Hebrew, with and without setting `Sys.setlocale("LC_ALL", "Hebrew")`.
- Best performance was achieved on `R` version > 3.5.0.
## Authors
- **Mattan S. Ben-Shachar** [aut, cre].
- **Almog Simchon** [aut, cre].