https://github.com/robinlovelace/rmarkingdown
Mark and test the reproducibility of R/RMarkdown submissions with this template
https://github.com/robinlovelace/rmarkingdown
Last synced: about 1 month ago
JSON representation
Mark and test the reproducibility of R/RMarkdown submissions with this template
- Host: GitHub
- URL: https://github.com/robinlovelace/rmarkingdown
- Owner: Robinlovelace
- Created: 2020-03-24T07:09:54.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-06T10:50:09.000Z (almost 5 years ago)
- Last Synced: 2025-04-03T16:12:21.677Z (about 2 months ago)
- Language: TeX
- Size: 8.79 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.Rmd
Awesome Lists containing this project
README
---
tile: Marking with RMarkdown template
author: Robin Lovelace
output: github_document
bibliography: references.bib
# output:
# html_document:
# toc: true
# number_sections: true
---
# rmarkingdown
```{r, include=FALSE}
knitr::opts_chunk$set()
```
# Quickstart {-}
To get started with this template:
- Create a new RStudio project in a suitable place and with a suitable name, e.g. `~/modules/tds/marks-2020` and open it up.
- Download and unzip the contents of this template with the following commands in the new project:
```{r, eval=FALSE}
u = "https://github.com/Robinlovelace/rmarkingdown/archive/master.zip"
download.file(u, "master.zip")
unzip("master.zip")
files_to_move = list.files(path = "rmarkingdown-master/", pattern = "*", full.names = TRUE)
destinations = basename(files_to_move)
file.copy(
from = files_to_move,
to = ".",
overwrite = FALSE, # avoid deleting files
recursive = TRUE
)
```
# Introduction {-}
This document contains code and text for evaluating and providing feedback to students who submitted reports for the module [xxx](web-link).
It aims to use the power of RMarkdown [@R-rmarkdown] to automate some parts of the process, and to provide individual (for students), and whole assessment level reports (for staff) in RMarkdown and html (or other) formats.
The feedback is designed to be constructive.
## Feedback criteria
Feedback is assessed using the following criteria, partly influenced by a document from the [Oxford Learning Institute](https://www.learning.ox.ac.uk/media/global/wwwadminoxacuk/localsites/oxfordlearninginstitute/documents/overview/rsv/Guidelines_for_giving_and_receiving_feedback.pdf), under the following headings:
- Demonstration of learning outcomes
- Reproducibility
- Positives
- Areas for improvement
- Ideas for further research
## Set-up
Template feedback files were created as follows:
```{r feedback, eval=FALSE}
# Adapt this for your own feedback:
feedback_template = "
# Candidate
## Positives
## Ideas for further research
## ...
"
```
You can also read-in a feedback template (recommended for modularity):
```{r ftemplate, eval=FALSE}
feedback_template = readLines("feedback-template.Rmd") # from known source
n_submissions = 3
submission_numbers = formatC(x = 1:n_submissions, width = 2, flag = 0)
lapply(submission_numbers, dir.create)
submission_names = paste0("submission", submission_numbers, ".Rmd")
# test writing template file
write_template = function(x) {
writeLines(text = feedback_template, con = x)
}
write_template(submission_names[1])
rmarkdown::render("submission01.Rmd")
```
You can explore the template results before writing detailed feedback as follows:
```{r, eval=FALSE}
browseURL("submission01.html") # looks good
```
And create the template for all submissions like this:
```{r, eval=FALSE}
# create all template files
purrr::map(submission_names, ~write_template(.))
```
# Feedback
After running the above code chunks mark each submission by editing each .Rmd file, e.g. with:
```{r, eval=FALSE}
file.edit("submission01.Rmd") # mark submission1
file.edit("submission02.Rmd") # mark submission2
file.edit("submission03.Rmd") # mark submission3
```
This can then be included with the following chunk setting:
```
{r test-main1, child = 'submission01.Rmd'}
```
```{r test-main1, child = 'submission01.Rmd'}
```
# submission 2: no submission
```{r test-main2, child = 'submission02.Rmd', eval=FALSE}
```
```{r test-main3, child = 'submission03.Rmd'}
```
# Auto-generating submission chunks
Another step that can be automated is generating the Rmarkdown chunks for each submission.
This can be done as follows:
```
make_chunk_submission = function(n) {
paste0("
```{r test-main, child = 'submission", n, ".Rmd', eval = FALSE}
```
")
}
make_chunk_submission("01")
make_chunk_submissions = function(submission_numbers) {
purrr::map_chr(submission_numbers, make_chunk_submission)
}
chunk_submissions_text = make_chunk_submissions(submission_numbers)
writeLines(chunk_submissions_text, "chunk_submissions_text.Rmd")
file.edit("chunk_submissions_text.Rmd")
```
## References