https://github.com/rstudio/gradethis
Tools for teachers to use with learnr
https://github.com/rstudio/gradethis
Last synced: 5 months ago
JSON representation
Tools for teachers to use with learnr
- Host: GitHub
- URL: https://github.com/rstudio/gradethis
- Owner: rstudio
- License: other
- Created: 2018-03-25T19:49:44.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2023-07-05T17:03:53.000Z (almost 2 years ago)
- Last Synced: 2024-08-03T06:03:07.499Z (8 months ago)
- Language: R
- Homepage: https://pkgs.rstudio.com/gradethis/
- Size: 2.1 MB
- Stars: 160
- Watchers: 15
- Forks: 39
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - rstudio/gradethis - Tools for teachers to use with learnr (R)
README
# gradethis 
[](https://CRAN.R-project.org/package=gradethis)
[](https://github.com/rstudio/gradethis/actions)
[](https://app.codecov.io/gh/rstudio/gradethis?branch=main)
[](http://www.rpackages.io/package/gradethis)
[](https://zenodo.org/badge/latestdoi/126734088)
gradethis helps scale feedback for [learnr] exercises. Instructors can use a model solution as a template or write highly customized testing logic to provide specific feedback for common mistakes.
gradethis is designed for use in [learnr] tutorials. We recommend that you first be comfortable writing learnr tutorials before you begin incorporating exercise feedback with gradethis. You can learn more about learnr tutorials with the [learnr package documentation][learnr].
## Installation
gradethis is still in development and not on [CRAN](https://CRAN.R-project.org) yet.
The development version of gradethis can be installed from GitHub with:
```r
# install.packages("remotes")
remotes::install_github("rstudio/gradethis")
```
## Usage
To use gradethis in a learnr tutorial, start by loading gradethis after learnr in the `setup` chunk of your tutorial:
````markdown
```{r setup}
library(learnr)
library(gradethis)
```
````
gradethis provides two grading modalities. You can:
1. Compare student code to model solution code with `grade_this_code()`, or
1. Write custom grading logic with `grade_this()`.
Learn more about where and how to write exercise-checking code in `vignette("gradethis")`.
## Getting help
[](https://community.rstudio.com/c/teaching/13)
[](https://community.rstudio.com/new-topic?title=&category_id=13&tags=gradethis&body=%0A%0A%0A%20%20--------%0A%20%20%0A%20%20%3Csup%3EReferred%20here%20by%20%60gradethis%60%27s%20README%3C/sup%3E%0A)
There are two main places to get help:
1. The [gradethis tag on RStudio Community](https://community.rstudio.com/tag/gradethis) is a friendly place to ask any questions about gradethis and the R Markdown family of packages. Additionally, we invite instructors to join the [Teaching Category on RStudio Community](https://community.rstudio.com/c/teaching/13), where any discussions about teaching are welcome.
1. [Stack Overflow](https://stackoverflow.com/questions/tagged/gradethis) can be a source of answers to common gradethis questions. It is also a great place to get help, once you have created a [reproducible example](https://reprex.tidyverse.org) that illustrates your problem.
## Code of Conduct
Please note that the gradethis project is released with a [Contributor Code of Conduct](https://friendly-golick-0771f8.netlify.app/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
[learnr]: https://rstudio.github.io/learnr/