R Interface to AirBnb's Knowledge Repository
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R
man-roxygen
man
.Rbuildignore
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
DESCRIPTION
LICENSE.md
NAMESPACE
README.Rmd
README.md
appveyor.yml
knowledgerepo.Rproj

README.md

Travis build status AppVeyor Build Status

knowledgerepo

The knowledgerepo package is a wrapper around AirBnB's Knowledge Repository project, particularly the command line tools included within the project. Its goal is to make it easy to create and submit knowledge posts from within an R session.

Installation

Use the remotes package to install the development version from GitHub:

remotes::install_github("dgrtwo/knowledgerepo")

You'll also need to install the knowledge_repo Python package from your terminal.

[sudo] pip install --upgrade knowledge-repo

Usage

The package offers functions, each prefixed with kr_, that wrap the knowledge_base command line interface. For example, knowledge_repo init is replaced with kr_init, and knowledge_repo add replaced with kr_add.

library(knowledgerepo)

# Initialize a repository
repo_dir <- tempfile()
kr_init(repo_dir)

# Create a test post
test_file <- tempfile(fileext = ".Rmd")
kr_create(test_file)

# Create a test post
kr_add(test_file, path = "examples/test_post", repo = repo_dir)

Once you've added a remote GitHub repository, you can also submit the post for review.

# Submit it for review
kr_submit("examples/test_post", repo = repo)

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.