createRepo: createRepo

In RepoGenerator: Generates a Project and Repo for Easy Initialization of a Workshop

Description

Creates a new project and pushes it to GitHub

Usage

createRepo(name, path, data, packages = c("here", "knitr", "rmarkdown",
  "tidyverse", "usethis"), user, organizer = user, token = "GITHUB_PAT",
  readme, ssh = TRUE)

Arguments

name	Name to use for project and repo
path	Location for the new project
data	data.frame listing data sources. Must have at least the following columns: Local (the name the file should be on disk after downloaded), Remote (the URL of the file), Mode (the way to write to disk, either 'w' or 'wb').
packages	Vector of packages that the user will be instructed to install.
user	GitHub username
organizer	Name of organizer of class. This can be in the form a a Markdown-style link.
token	The name of the environment variable holding the GitHub access token. This can be set with base::Sys.setenv().
readme	Path to parameterized rmarkdown document with parameters className, organizer and packages. If missing the default from the package is used.
ssh	If TRUE, change the remote to use ssh instead of https

Details

This is designed to make a bare repo to be used for workshops. It will create a new project with a customized README and customized download file. It then pushes this to GitHub.

Value

If all operations are successful, returns TRUE

Author(s)

Jared P. Lander

RepoGenerator documentation built on May 2, 2019, 3:43 a.m.