/semestr

R package for generating and maintaining a course syllabus from a SQL database.

Primary LanguageRMIT LicenseMIT

semestr

Jonathan Gilligan 2023-01-02

semestr

Version: 0.2.1.9101 Lifecycle: experimental CRAN status License: MIT R-CMD-check

The goal of semestr is to manage a syllabus for a university course. The package uses a SQL database with a schedule of reading, homework, and laboratory assignments and due dates, exams, holidays, etc. There are functions for generating content for a HUGO-based web site with the semester schedule and the assignents, as well as PDF copies of the assignments and a full syllabus.

Status

This project is at a very early state of development and is not ready for general use. Use this at your own risk.

Installation

This package has not been released to CRAN. You can install the development version from GitHub using the remotes package:

remotes::install_github("jonathan-g/semestr")

Example

To get started, you need a SQL database. I have not yet written instructions or specifications for this database, but there is an example database planning/ees_3310/example_semester_db.sqlite3 and you can inspect it and figure out how it works.

library(semestr)
semester <- load_semester_db("planning/example_semester_db.sqlite3")
generate_assignments(semester)
build_pdf_files(semester)