Skip to content

Commit

Permalink
fixes prior to 2.3.9100 release
Browse files Browse the repository at this point in the history
  • Loading branch information
Myfanwy committed Nov 8, 2023
1 parent f5ab38b commit 6b6c686
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 33 deletions.
49 changes: 49 additions & 0 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, master]
pull_request:
branches: [main, master]

name: R-CMD-check

jobs:
R-CMD-check:
runs-on: ${{ matrix.config.os }}

name: ${{ matrix.config.os }} (${{ matrix.config.r }})

strategy:
fail-fast: false
matrix:
config:
- {os: macos-latest, r: 'release'}
- {os: windows-latest, r: 'release'}
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
- {os: ubuntu-latest, r: 'release'}
- {os: ubuntu-latest, r: 'oldrel-1'}

env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
R_KEEP_PKG_SOURCE: yes

steps:
- uses: actions/checkout@v3

- uses: r-lib/actions/setup-pandoc@v2

- uses: r-lib/actions/setup-r@v2
with:
r-version: ${{ matrix.config.r }}
http-user-agent: ${{ matrix.config.http-user-agent }}
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::rcmdcheck
needs: check

- uses: r-lib/actions/check-r-package@v2
with:
upload-snapshots: true
7 changes: 4 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,16 @@ gutenbergr: R package to search and download public domain texts from Project Gu
----------------

**Authors:** [David Robinson](http://varianceexplained.org/)<br/>
**License:** [GPL-2](https://opensource.org/licenses/GPL-2.0)
**License:** [GPL-2](https://opensource.org/license/gpl-2-0/)

<!-- badges: start -->
[![Build Status](https://travis-ci.org/ropensci/gutenbergr.svg?branch=master)](https://travis-ci.org/ropensci/gutenbergr)
[![Build Status](https://app.travis-ci.com/ropensci/gutenbergr.svg?branch=master)](https://app.travis-ci.com/ropensci/gutenbergr)
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/gutenbergr)]( https://CRAN.R-project.org/package=gutenbergr)
[![Build status](https://ci.appveyor.com/api/projects/status/lqb7hngtj5epsmd1?svg=true)](https://ci.appveyor.com/project/ropensci/gutenbergr-dujv9)
[![Coverage Status](https://img.shields.io/codecov/c/github/ropensci/gutenbergr/master.svg)](https://codecov.io/github/ropensci/gutenbergr?branch=master)
[![Coverage Status](https://img.shields.io/codecov/c/github/ropensci/gutenbergr/master.svg)](https://app.codecov.io/github/ropensci/gutenbergr?branch=master)
[![rOpenSci peer-review](https://badges.ropensci.org/41_status.svg)](https://github.com/ropensci/software-review/issues/41)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![R-CMD-check](https://github.com/ropensci/gutenbergr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ropensci/gutenbergr/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

Download and process public domain works from the [Project Gutenberg](https://www.gutenberg.org/) collection. Includes
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@
## gutenbergr: R package to search and download public domain texts from Project Gutenberg

**Authors:** [David Robinson](http://varianceexplained.org/)<br/>
**License:** [GPL-2](https://opensource.org/licenses/GPL-2.0)
**License:** [GPL-2](https://opensource.org/license/gpl-2-0/)

<!-- badges: start -->

[![Build
Status](https://travis-ci.org/ropensci/gutenbergr.svg?branch=master)](https://travis-ci.org/ropensci/gutenbergr)
Status](https://app.travis-ci.com/ropensci/gutenbergr.svg?branch=master)](https://app.travis-ci.com/ropensci/gutenbergr)
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/gutenbergr)](https://CRAN.R-project.org/package=gutenbergr)
[![Build
status](https://ci.appveyor.com/api/projects/status/lqb7hngtj5epsmd1?svg=true)](https://ci.appveyor.com/project/ropensci/gutenbergr-dujv9)
[![Coverage
Status](https://img.shields.io/codecov/c/github/ropensci/gutenbergr/master.svg)](https://codecov.io/github/ropensci/gutenbergr?branch=master)
Status](https://img.shields.io/codecov/c/github/ropensci/gutenbergr/master.svg)](https://app.codecov.io/github/ropensci/gutenbergr?branch=master)
[![rOpenSci
peer-review](https://badges.ropensci.org/41_status.svg)](https://github.com/ropensci/software-review/issues/41)
[![Project Status: Active – The project has reached a stable, usable
Expand Down Expand Up @@ -106,7 +106,7 @@ wuthering_heights
#> 8 768 "CHAPTER I"
#> 9 768 ""
#> 10 768 ""
#> # … with 12,332 more rows
#> # 12,332 more rows
```

`gutenberg_download` can download multiple books when given multiple
Expand All @@ -130,7 +130,7 @@ books
#> 8 768 "CHAPTER I" Wuthering Heights
#> 9 768 "" Wuthering Heights
#> 10 768 "" Wuthering Heights
#> # … with 33,333 more rows
#> # 33,333 more rows

books %>%
count(title)
Expand All @@ -150,7 +150,7 @@ aristotle_books <- gutenberg_works(author == "Aristotle") %>%
gutenberg_download(meta_fields = "title")

aristotle_books
#> # A tibble: 43,801 × 3
#> # A tibble: 17,147 × 3
#> gutenberg_id text
#> <int> <chr>
#> 1 1974 "THE POETICS OF ARISTOTLE"
Expand All @@ -175,7 +175,7 @@ aristotle_books
#> 8 The Poetics of Aristotle
#> 9 The Poetics of Aristotle
#> 10 The Poetics of Aristotle
#> # … with 43,791 more rows
#> # ℹ 17,137 more rows
```

### FAQ
Expand Down Expand Up @@ -208,8 +208,8 @@ See the
[data-raw](https://github.com/ropensci/gutenbergr/tree/master/data-raw)
directory for the scripts that generate these datasets. As of now, these
were generated from [the Project Gutenberg
catalog](https://www.gutenberg.org/ebooks/offline_catalogs.html) on **04
November 2022**.
catalog](https://www.gutenberg.org/ebooks/offline_catalogs.html) on **19
December 2022**.

#### Do you respect the rules regarding robot access to Project Gutenberg?

Expand Down
36 changes: 15 additions & 21 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,32 @@
# gutenbergr 0.2.3
## gutenbergr 2.3.9100

This release is a re-submission and maintainer change after gutenbergr 0.2.1 was archived.
This release is a re-submission after gutenbergr 2.3.0 was archived.

## Changes

Major changes:

* New package maintainer: Myfanwy Johnston <[email protected]>

Minor changes:

* Updated package metadata.

Miscellaneous:

* Documentation updates and fixes throughout (updated to latest version of roxygen2, resolved missing return value and examples, removed/updated broken urls)
* On advice to minimize server time in test environments, some gutenberg_download() and gutenberg_works() examples are now wrapped in donttest{}.
* Some examples in `gutenberg_download()` have been updated to `@examplesIf interactive()` to address graceful failure while preserving the interactive intent of the functions.
* Three badge urls in the README have been updated

## Test environments

* local OS X install, R 4.2.1
NOTEs: installed package size, found marked UTF-8 strings in the data directory. These strings are in the metadata from Project Gutenberg.
* local OS X install, R 4.3.2
2 NOTEs: installed package size, found marked UTF-8 strings in the data directory. These strings are in the metadata from Project Gutenberg.

* Windows Server 2022 x64 (build 20348)
NOTE: New submission

* Ubuntu Linux 20.04.1 LTS, R-release, GCC
NOTEs: new submission, installed package size, examples with CPU (user + system) or elapsed time > 5s
Package was archived on CRAN

* Fedora Linux, R-devel, clang, gfortran
NOTEs: new submission, installed package size, examples with CPU (user + system) or elapsed time > 5s, Skipping checking HTML validation: no command 'tidy' found
Version contains large components (0.2.3.9100)

* Windows Server 2022, 10.0.20348
NOTE: marked UTF-8 strings; see above
CRAN repository db overrides:
X-CRAN-Comment: Archived on 2023-08-10 for policy violation.

## R CMD check results

0 errors | 0 warnings | 2 notes

The NOTEs are: 1) new submission after the package was archived, and 2) installed size is 5.0Mb. This due to the data requirements of the package and the text files from Project Gutenberg for use in the examples. We reduced the number of files in this release and will strive to further reduce the size of the installed package in the next release.
* Package was archived on CRAN for policy violation On Internet access.
* installed size is 5.3MB; sub-directories of 1Mb or more: data (4.9Mb). This due to the data requirements of the package and the text files from Project Gutenberg for use in the examples. We will strive to further reduce the size of the installed package in the next major release.

0 comments on commit 6b6c686

Please sign in to comment.