kr_submit: Submit a post to the knowledge base for review

In dgrtwo/knowledgerepo: R Interface to Knowledge Repository

Description

Submit a post to the knowledge base for review. This would be done after adding it with kr_add (assuming submit was FALSE in that command).

Usage

kr_submit(path, repo = Sys.getenv("KNOWLEDGE_REPO"), browse_pr = FALSE,
  master = FALSE, ...)

Arguments

path	The path of the knowledge post to submit for review.
repo	Repository of the knowledge post to add
browse_pr	Whether to browse to a GitHub pull request for submitting this post
master	Whether to submit it on master rather than on a separate branch (allowing for review). If TRUE, rather than using the knowlege_base CLI it locally merges to master than pushes. Works only if you have commit access to master.
...	Global arguments to knowledge_repo commands, such as repo or noupdate (see Details)

Details

The "direct" option is not supported by the knowledge_repo command line interface, and is a shortcut provided by this package.

Global arguments that can be passed to all knowledge_repo commands include:

• repoPath to Knowledge Repository to add to. Can also set KNOWLEDGE_REPO variable in .Renviron.

• devWhether to skip passing control to version of code checked out in knowledge repository.

• debugWhether to enable debug mode.

• noupdateWhether script should update the repository before performing actions.

• versionShow version and exit.

• helpShow help and exit

Examples

# set up a repository and post
repo <- tempfile()
kr_init(repo)
kr_create("test.Rmd", repo = repo)

# add to knowledge repo
kr_add("test.Rmd", repo = repo, path = "tests/test")

## Not run: 
# submit to remote repository
kr_submit("tests/test")

## End(Not run)

dgrtwo/knowledgerepo documentation built on May 25, 2019, 4:23 p.m.