qcbsrworkshops's Introduction

qcbsRworkshops

The goal of the qcbsRworkshops 📦 is to ease the development and editions of the QCBS R workshops.

Installation

You can install the development version of qcbsRworkshops with remotes 📦:

install.packages("remotes")
remotes::install_github("QCBSRworkshops/qcbsRworkshops")

Once installed, you can load the package:

library(qcbsRworkshops)

How to

Build workshops

There are two options:

the sources of the workshop are already in your computer, then use:

# if the workshop folder is the current directory (preferred), then use
build_workshops()
# if the path to the workshop folder is "path2workshop", then use
build_workshops("path2workshop")

the sources of a the workshop must be downloaded, in such case a zip file will be downloaded:

build_workshops(download = TRUE, id = 1)

Clean workshops

To clean up cache and files created during the build of the workshop (the slides), use

# if the workshop folder is the current directory (preferred), then use
clean_workshops()
# if the path to the workshop folder is "path2workshop", then use
build_workshops("path2workshop")

Update template

To update the template (see https://github.com/QCBSRworkshops/templateWorkshops), use

# if the workshop folder is the current directory (preferred), then use
update_template()
# if the path to the workshop folder is "path2workshop", then use
update_template("path2workshop")

Extract R code

knitr provides a nice function that extract R code from all code chunk and this 📦 has a wrapper to extract the code for all the workshops in your working directory.

extract_Rcode_workshops("path2workshop")

Presenter email

mail_workshop() generates emails te be sent to participants ~2 weeks before the workshop. Just add your name and the details and an email will be generated that you can copy-paste.

mail_workshop(7, pres_name = "Kevin Cazelles", lang = "both",
   details_fr = "à l'UdeM, salle A-2553, campus MIL, le vendredi 28 Février 2020 de 13h à 17h",
   details_en = "at the UdeM, MIL campus, room A-2553, on Friday February 28th 2020, 1pm-5pm"
)

Contributor Code of Conduct

Please note that the 'qcbsRworkshops' project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

qcbsrworkshops's People

Stargazers

Watchers

qcbsrworkshops's Issues

Github actions for windows

Looks like something is wrong with windows setup!
https://github.com/r-lib/actions/runs/495643225?check_suite_focus=true
Let's wait and see and ignore the error in the meanwhile.

Vignette

Let's show how to use this package to develop the workshops in a vignette.

Better usage of `remotes` to install packages

For some reason, I created a handful functions to download packages from CRAN, repo, .... Those functions basically called install.packages after downloading the files. Given that we are already using a DESCRIPTION file and remotes, it'd be better to callinstall_deps() and use pkg.yaml as little as possible (only when packages are archived, and we avoid using those packages).