installWorkshops: Install workshops from locations as indicated by main...

Description Usage Arguments

View source: R/installWorkshops.R

Description

This function looks at the 'issues' page of the main repository and installs from the workshop URLs tagged as '[Workshop]'

Usage

1
2
3
4
5
6
7
8
9
installWorkshops(
  workshops = NULL,
  exclude = FALSE,
  repository = workshopbuilder:::.options$get("BOOK_REPO"),
  local = workshopbuilder:::.options$get("REPOS_PATH"),
  buildDir = "buildout",
  ncpus = 1L,
  ...
)

Arguments

workshops

character() An optional vector of workshop repositories to install. Default behavior installs all workshops.

exclude

logical(1) Whether to include or exclude the workshop(s) listed in the argument from the full list of workshops (default FALSE)

repository

A single string indicating the 'username/repository' of the main book-building GitHub repository (defaults to package option 'BOOK_REPO')

local

character(1) The folder location for all cloned workshop repositories

buildDir

character(1) The folder location for all workshop installation reports (within the 'local' folder)

ncpus

integer(1) The number of CPUs to use for the building and installation of workshop repositories (default: 1L)


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