https://github.com/aschleg/rpoet

R wrapper for the PoetryDB API.
https://github.com/aschleg/rpoet

api-wrapper poetry

Last synced: about 2 months ago
JSON representation

R wrapper for the PoetryDB API.

• Host: GitHub
• URL: https://github.com/aschleg/rpoet
• Owner: aschleg
• Created: 2018-06-23T21:11:24.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-08-19T19:00:58.000Z (over 5 years ago)
• Last Synced: 2025-01-13T08:46:11.613Z (3 months ago)
• Topics: api-wrapper, poetry
• Language: R
• Homepage: https://cran.r-project.org/web/packages/Rpoet/index.html
• Size: 23.4 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md

Awesome Lists containing this project

README

        
# Rpoet - R wrapper for the PoetryDB API

[![Build Status](https://travis-ci.org/aschleg/Rpoet.svg?branch=master)](https://travis-ci.org/aschleg/Rpoet)

[![Build status](https://ci.appveyor.com/api/projects/status/7tydn9veo15s77a1?svg=true)](https://ci.appveyor.com/project/aschleg/rpoet)

[![codecov](https://codecov.io/gh/aschleg/Rpoet/branch/master/graph/badge.svg)](https://codecov.io/gh/aschleg/Rpoet)

![https://cran.r-project.org/package=Rpoet](https://www.r-pkg.org/badges/version/Rpoet)

`Rpoet` is a wrapper of the [PoetryDB API](http://poetrydb.org) that enables users to access the PoetryDB through an R interface. 

## Installation

`Rpoet` is most easily installed through `install.packages`.

~~~ r

install.packages('Rpoet')

~~~

The package can also be installed through the `devtools` function `install_github`:

~~~ r

devtools::install_github('aschleg/Rpoet')

~~~

## Documentation

* [Rpoet Reference Manual](https://cran.r-project.org/web/packages/Rpoet/Rpoet.pdf)

  - The API manual as a PDF available on CRAN.

* [Introduction to Rpoet](https://cran.r-project.org/web/packages/Rpoet/vignettes/Rpoet_Introduction.html)

  - A short vignette that introduces the primary functionality of the package.

* [PoetryDB API Documentation](https://github.com/thundercomb/poetrydb/blob/master/README.md) 

  - Includes further information on the design and implementation of the PoetryDB database with MongoDB.

## About PoetryDB

[PoetryDB](http://poetrydb.org) was created and is currently maintained by [@thundercomb](https://twitter.com/thundercomb). They blog about poetry and related technology and other topics at [thecombedthunderclap.blogspot.com](http://thecombedthunderclap.blogspot.com/). 

Please note, I am in no way affiliated with the creator of PoetryDB. My intention with `Rpoet` is to help spread the word and hopefully increase interest in poetry and related projects that attempt to create a comprehensive databases of publicly available knowledge.