In charlotte-ngs/rcoursetools: R Course Tools

devtools::load_all()

The R-package rcoursetools aims at providing some useful tools for teachers to create and mangage their course material. The idea behind rcoursetools is to use R's package infrastructure in order to organize and to bundle all material that is required for a course.

Starting from scratch

When starting a new course, we want to create some basic infrastructure or some sort of ecosystem where the course material can be stored. This infrastructure uses the R-package system to create a skeleton for our course material. The basic course infrastructure is created using the function create_course() which requires two arguments

1. a course directory
2. a course name

The course directory specifies the directory in the file system where the course will be created and the course name specifies how the subdirectory below which all material should be stored is called.

create_course(psCourseName = "AZNASN", psCourseDir = "/Users/peter/Data/Projects/Courses", pbOverWrite = TRUE)

Create a website

Nowadays, teaching material is distributed to students using a website. Hence one of the tasks when starting to prepare for a new course is to create a website. We create the website starting from a template. This template contains placeholders which are to be replaced by information which is specific to our course.

create_course_website(psCourseName = "AZNASN", psCourseDir = "/Users/peter/Data/Projects/Courses")

Now that the skeleton for the website is created, we can go and get creative and fill in the content of the course into that site. This can be done using the command

file.edit("/Users/peter/Data/Projects/Courses/AZNASN/vignettes/index.Rmd")

charlotte-ngs/rcoursetools documentation built on May 13, 2019, 3:34 p.m.