Package 'sportsdataverse'

Title: Easily Install and Load the 'SportsDataverse'
Description: Installs and loads, in a single step, the set of 'sportsdataverse' sports data packages, which work in harmony because they share common data representations and 'API' design. Also reports and updates the installed versions of those packages. Learn more about the 'sportsdataverse' at <https://sportsdataverse.org>.
Authors: Saiem Gilani [aut, cre, cph] (ORCID: <https://orcid.org/0000-0002-7194-9067>)
Maintainer: Saiem Gilani <[email protected]>
License: MIT + file LICENSE
Version: 0.3.0
Built: 2026-10-18 21:20:02 UTC
Source: https://github.com/sportsdataverse/sportsdataverse-R

Help Index


List of all packages in the SportsDataverse

Description

List of all packages in the SportsDataverse

Usage

get_core_functions()

Value

A character vector of the CRAN packages that library(sportsdataverse) attaches.

Examples

get_core_functions()

List all sportsdataverse dependencies

Description

List all sportsdataverse dependencies

Usage

sportsdataverse_deps(
  recursive = TRUE,
  pkg_list = get_core_functions(),
  repos = getOption("repos")
)

Arguments

recursive

If TRUE, will also list all dependencies of sportsdataverse packages.

pkg_list

Character vector of the package names to check. Defaults to the attached roster, get_core_functions().

repos

The repositories to use to check for updates. Defaults to getOptions("repos").

Value

A data.frame with one row per dependency and columns package, cran, local, and behind.

Examples

try(sportsdataverse_deps())

List all packages in the sportsdataverse

Description

List all packages in the sportsdataverse

Usage

sportsdataverse_packages(include_self = TRUE)

Arguments

include_self

Include sportsdataverse in the list?

Value

A sorted character vector of package names.

Examples

sportsdataverse_packages()

Get a situation report on the sportsdataverse

Description

This function gives a quick overview of the versions of R and RStudio as well as all sportsdataverse packages. It's primarily designed to help you get a quick idea of what's going on when you're helping someone else debug a problem.

Usage

sportsdataverse_sitrep()

Value

Called for its side effect of printing the report; returns NULL invisibly.

Examples

try(sportsdataverse_sitrep())

Update sportsdataverse packages

Description

This will check to see if all sportsdataverse packages (and optionally, their dependencies) are up-to-date, and prints the install command needed to bring any out-of-date packages current.

Usage

sportsdataverse_update(
  recursive = FALSE,
  repos = getOption("repos"),
  devel = FALSE
)

Arguments

recursive

If TRUE, will also list all dependencies of sportsdataverse packages.

repos

The repositories to use to check for updates. Defaults to getOptions("repos").

devel

If TRUE, look for prebuilt development versions on the SportsDataverse r-universe (https://sportsdataverse.r-universe.dev) so it is possible to install development versions without GitHub.

Value

Returns NULL invisibly. Called for its side effects.

Examples

try(sportsdataverse_update())