README.md

In Bioconductor/workshopbuilder: This package compiles workshops from different locations into a central bookdown workshop repository

workshopbuilder

A package to install and render workshop vignettes. The workshop locations (on GitHub) are read from the main book repository's (Bioconductor/BiocWorkshops2019) issues.

Installation

BiocManager::install("Bioconductor/workshopbuilder")

Workflow

A typical workflow would involve setting a few package options:

1) Main book repository on GitHub

.options$set("BOOK_REPO", "Bioconductor/BiocWorkshops2019")

2) Local workshop book directory

.options$set("LOCAL_REPO", normalizePath("~/BiocWorkshops2019"))

3) Local workshop repositories directory

.options$set("REPOS_PATH", normalizePath("~/Bioconductor/Workshops"))

After the initial setup, building a workshop is as follows:

library(workshopbuilder)

workshop_meta <- installWorkshops("MultiAssayWorkshop",
    exclude = FALSE, ncpus = 12)

getBookRepo()

addWorkshops(workshop_meta)

rmds <- transferVignettes(workshop_meta)

addRmdFiles(rmds)

renderWorkshops(format = "all")

Bioconductor/workshopbuilder documentation built on Dec. 2, 2019, 11:41 p.m.