Introduction

This repository holds the code to produce a report on the number of ethics self-checks performed in the Faculty of Social Sciences at the VU. This relies on using the R package "qualtRics" to download information from Qualtrics into R, and then using knitr to create a pdf.

Setting up qualtrics

To use this, you need access to the Qualtrics selef check questionnaire and data. If you have this access, you then need to make sure you have an API token. See here. Finally, you need to register your qualtrics credentials in the quatRics package use the qualtrics_api_credentials() function: simply copy your API key into the R code below, and run it. Your credentials will be added to your system environment, so you will only have to run this code once. If you want to adapt this to your own survey, you will also need to chane the base_url. See the qualtRics documentation for more info.

qualtrics_api_credentials(api_key = "APIKEY", 
                          base_url = "vuass.fra1.qualtrics.com",
                          install = TRUE,
                          overwrite=TRUE)

readRenviron("~/.Renviron")

Building the report

You can use RStudio to render the "rerc_selfcheck_overview.rmd" file. Make sure to set your working directory first. The file will run two other R scripts to download data and create tables. The data should not be synced with GitHub, since it contains personal data.

The rmd file will aim to output a PDF, for which you will need a LaTeX installation. If this is problematic, the rmd file can be adapted to output HTML.