Package 'nflversedata'

Title: nflverse data storage functions
Description: This repository holds automated data releases for nflverse projects and helper functions for managing the uploads.
Authors: Tan Ho [aut, cre]
Maintainer: Tan Ho <[email protected]>
License: CC BY 4.0
Version: 0.0.12
Built: 2024-11-19 06:26:49 UTC
Source: https://github.com/nflverse/nflverse-data

Help Index

Archive nflverse

Description

Archive nflverse

Usage

nflverse_archive(release_name, archive_tag)

Arguments

release_name

Name of the release
archive_tag

The release tag to which data from release_name should be uploaded

Save files to nflverse release

Description

This functions attaches nflverse attributes like type and timestamp, saves data to a temporary directory in all four of csv, rds, parquet, and qs formats, and then uploads to nflverse-data repository for a specified release tag.

Usage

nflverse_save(
  data_frame,
  file_name,
  nflverse_type,
  release_tag,
  file_types = c("rds", "csv", "parquet", "qs", "csv.gz"),
  repo = "nflverse/nflverse-data"
)

Arguments

data_frame

data_frame to save
file_name

file_name to upload as, without the file extension
nflverse_type

metadata: name/information to add to data
release_tag

name of release to upload to
file_types

one or more of ⁠"rds", "csv", "parquet", "qs", "csv.gz"⁠
repo

repository to upload to, default: "nflverse/nflverse-data"

Upload to nflverse release

Description

Upload to nflverse release

Usage

nflverse_upload(...)

Arguments

...

currently not used
files

vector of filepaths to upload
tag

release name
repo

repository to upload to, default: "nflverse/nflverse-data"
overwrite

If TRUE (the default) existing files will be overwritten