clone_git_template: Create Notes

Description Usage Arguments

View source: R/clone_git_template.R

Description

Creates a Jumping Rivers style notes directory. This assumes you have set up a private SSH key for Git.

Usage

1
clone_git_template(name = NULL, path = NULL, push = FALSE)

Arguments

name

The title of the notes directory you want to create i.e. jRintroduction_notes. This defaults to "jRexample_notes". To force you to create a directory with a name other than the default, the default will break the function. Unless the proper notation for a jumping rivers notes directory is followed the function will have a paddy! i.e. must start with a "jr" and end in "_notes".

path

The path where you want to place the notes. Default is NULL, which will create the notes directory inside your current working directory.

push

Default FALSE. TRUE to push and create the repo.


jr-packages/jrNotes documentation built on Dec. 18, 2020, 11:07 p.m.