https://github.com/jonthegeek/gutenbergr.data

Project Gutenberg Metadata
https://github.com/jonthegeek/gutenbergr.data

Last synced: 10 days ago
JSON representation

Project Gutenberg Metadata

• Host: GitHub
• URL: https://github.com/jonthegeek/gutenbergr.data
• Owner: jonthegeek
• License: other
• Created: 2024-09-12T11:05:44.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-10-24T02:19:19.000Z (15 days ago)
• Last Synced: 2024-10-24T18:55:13.205Z (14 days ago)
• Language: R
• Homepage: https://jonthegeek.github.io/gutenbergr.data/
• Size: 12.3 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.Rmd
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# gutenbergr.data

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)

[![CRAN status](https://www.r-pkg.org/badges/version/gutenbergr.data)](https://CRAN.R-project.org/package=gutenbergr.data)

[![Codecov test coverage](https://codecov.io/gh/jonthegeek/gutenbergr.data/graph/badge.svg)](https://app.codecov.io/gh/jonthegeek/gutenbergr.data)

[![R-CMD-check](https://github.com/jonthegeek/gutenbergr.data/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jonthegeek/gutenbergr.data/actions/workflows/R-CMD-check.yaml)

The [{gutenbergr}](https://docs.ropensci.org/gutenbergr/) package provides functions to fetch works from [Project Gutenberg](https://www.gutenberg.org/).

It relies on metadata about the Project Gutenberg collection.

The catalog metadata is updated *daily* by Project Gutenberg, but only rarely within {gutenbergr} itself.

This package seeks to alleviate that issue, by:

- Providing functions to fetch and process an up-to-date version of the catalog.

- Automatically updating the catalog metadata within this package on a regular basis (at least weekly).

- Automatically updating the (CRAN) released version of this package on a regular basis (timeframe TBD).

## Installation

You can install the development version of gutenbergr.data from [GitHub](https://github.com/) with:

``` r

# install.packages("pak")

pak::pak("jonthegeek/gutenbergr.data")

```

## Usage

(This package does not yet contain any code, so it does not include usage information)

## Code of Conduct

Please note that the gutenbergr.data project is released with a [Contributor Code of Conduct](https://jonthegeek.github.io/gutenbergr.data/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.