Skip to content

Commit

Permalink
update desc, news, readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tanho63 committed Dec 8, 2021
1 parent 7eb4de2 commit e140258
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 9 deletions.
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: nflreadr
Title: Download 'nflverse' Data
Version: 1.1.1.03
Version: 1.1.2
Authors@R: c(
person("Tan", "Ho", , "[email protected]", role = c("aut", "cre", "cph"),
comment = c(ORCID = "0000-0001-8388-5155")),
Expand All @@ -10,7 +10,7 @@ Authors@R: c(
person("Thomas", "Mock", role = "ctb"),
person("Lee", "Sharpe", role = "ctb")
)
Description: A low-level package for downloading data from 'GitHub'
Description: A minimal package for downloading data from 'GitHub'
repositories of the 'nflverse' project.
License: MIT + file LICENSE
URL: https://nflreadr.nflverse.com, https://github.com/nflverse/nflreadr
Expand Down
6 changes: 3 additions & 3 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# nflreadr (development version)
# nflreadr 1.1.2

## New Functions

- `nflverse_sitrep()` and `ffverse_sitrep()` give a minimal overview of the package dependencies (v1.1.1.01)
- `nflverse_sitrep()` and `ffverse_sitrep()` give a minimal overview of the package dependencies
- Minimum R version bumped to R 3.6.0 - this is the minimum version required to read the [current RDS file-version](https://stat.ethz.ch/R-manual/R-devel/library/base/html/readRDS.html).
- `_sitrep()` fns receive a small print-related bugfix and coloring improvement (v1.1.1.03)
- `_sitrep()` functions receive a small print-related bugfix and colouring improvement.

---

Expand Down
6 changes: 4 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ options(tibble.max_extra_cols = 20,

<!-- badges: start -->
[![CRAN status](https://img.shields.io/cran/v/nflreadr?style=flat-square&logo=R&label=CRAN)](https://CRAN.R-project.org/package=nflreadr)
[![Codecov test coverage](https://img.shields.io/codecov/c/github/nflverse/nflreadr?label=codecov&style=flat-square&logo=codecov)](https://codecov.io/gh/nflverse/nflreadr?branch=main)
[![Codecov test coverage](https://img.shields.io/codecov/c/github/nflverse/nflreadr?label=codecov&style=flat-square&logo=codecov)](https://app.codecov.io/gh/nflverse/nflreadr?branch=main)
[![Dev status](https://img.shields.io/github/r-package/v/nflverse/nflreadr/main?label=dev%20version&style=flat-square&logo=github)](https://nflreadr.nflverse.com/)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg?style=flat-square)](https://lifecycle.r-lib.org/articles/stages.html)
[![R build status](https://img.shields.io/github/workflow/status/nflverse/nflreadr/R-CMD-check?label=R%20check&style=flat-square&logo=github)](https://github.com/nflverse/nflreadr/actions)
[![nflverse discord](https://img.shields.io/discord/789805604076126219?color=7289da&label=nflverse%20discord&logo=discord&logoColor=fff&style=flat-square)](https://discord.com/invite/5Er2FBnnQa)

<!-- badges: end -->

nflreadr is a low-level package for downloading data from nflverse repositories. It includes caching, optional progress updates, and data dictionaries.
nflreadr is a minimal package for downloading data from nflverse repositories. It includes caching, optional progress updates, and data dictionaries.

## Installation

Expand Down Expand Up @@ -71,6 +71,8 @@ For a full list of functions, please see the [reference page](https://nflreadr.n

This data is maintained by the nflverse project team and is primarily automated via GitHub Actions. You can check the status and schedules page here: https://github.com/nflverse/status

For Python access to nflverse data, please check out [nfl-data-py](https://pypi.org/project/nfl-data-py/) which is maintained by Cooper Adams.

## Configuration

The following options help configure default `nflreadr` behaviours.
Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![CRAN
status](https://img.shields.io/cran/v/nflreadr?style=flat-square&logo=R&label=CRAN)](https://CRAN.R-project.org/package=nflreadr)
[![Codecov test
coverage](https://img.shields.io/codecov/c/github/nflverse/nflreadr?label=codecov&style=flat-square&logo=codecov)](https://codecov.io/gh/nflverse/nflreadr?branch=main)
coverage](https://img.shields.io/codecov/c/github/nflverse/nflreadr?label=codecov&style=flat-square&logo=codecov)](https://app.codecov.io/gh/nflverse/nflreadr?branch=main)
[![Dev
status](https://img.shields.io/github/r-package/v/nflverse/nflreadr/main?label=dev%20version&style=flat-square&logo=github)](https://nflreadr.nflverse.com/)
[![Lifecycle:
Expand All @@ -20,7 +20,7 @@ discord](https://img.shields.io/discord/789805604076126219?color=7289da&label=nf

<!-- badges: end -->

nflreadr is a low-level package for downloading data from nflverse
nflreadr is a minimal package for downloading data from nflverse
repositories. It includes caching, optional progress updates, and data
dictionaries.

Expand Down Expand Up @@ -88,6 +88,10 @@ This data is maintained by the nflverse project team and is primarily
automated via GitHub Actions. You can check the status and schedules
page here: <https://github.com/nflverse/status>

For Python access to nflverse data, please check out
[nfl-data-py](https://pypi.org/project/nfl-data-py/) which is maintained
by Cooper Adams.

## Configuration

The following options help configure default `nflreadr` behaviours.
Expand Down

0 comments on commit e140258

Please sign in to comment.