https://github.com/dgrtwo/knowledgerepo
R Interface to AirBnb's Knowledge Repository
https://github.com/dgrtwo/knowledgerepo
Last synced: 28 days ago
JSON representation
R Interface to AirBnb's Knowledge Repository
- Host: GitHub
- URL: https://github.com/dgrtwo/knowledgerepo
- Owner: dgrtwo
- License: other
- Created: 2018-02-22T21:04:07.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-06-18T12:33:46.000Z (almost 7 years ago)
- Last Synced: 2025-02-28T06:55:20.630Z (about 2 months ago)
- Language: R
- Size: 28.3 KB
- Stars: 28
- Watchers: 4
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - dgrtwo/knowledgerepo - R Interface to AirBnb's Knowledge Repository (R)
README
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
[](https://travis-ci.org/dgrtwo/knowledgerepo)
[](https://ci.appveyor.com/api/projects/status/github//dgrtwo/knowledgerepo/?branch=master&svg=true)
# knowledgerepo
The knowledgerepo package is a wrapper around [AirBnB's Knowledge Repository project](https://github.com/airbnb/knowledge-repo), 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](https://cran.r-project.org/web/packages/remotes/index.html) package to install the development version from GitHub:
```{r, eval = FALSE}
remotes::install_github("dgrtwo/knowledgerepo")
```
You'll also need to install the [knowledge_repo](https://github.com/airbnb/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`.
```{r eval = FALSE}
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.
```{r eval = FALSE}
# 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](CODE_OF_CONDUCT.md).
By participating in this project you agree to abide by its terms.