rdindex: Get Rdatasets Index

View source: R/rdindex.R

rdindexR Documentation

Get Rdatasets Index

Description

Downloads and returns the complete Rdatasets index as a data frame.

Usage

rdindex()

Value

A data frame containing all available datasets from Rdatasets with the following columns:

  • Package: Character. The name of the R package that contains the dataset

  • Dataset: Character. The name of the dataset

  • Title: Character. A descriptive title for the dataset

  • Rows: Integer. Number of rows in the dataset

  • Cols: Integer. Number of columns in the dataset

  • n_binary: Integer. Number of binary variables in the dataset

  • n_character: Integer. Number of character variables in the dataset

  • n_factor: Integer. Number of factor variables in the dataset

  • n_logical: Integer. Number of logical variables in the dataset

  • n_numeric: Integer. Number of numeric variables in the dataset

  • CSV: Character. URL to download the dataset in CSV format

  • Doc: Character. URL to the dataset's documentation

Global Options

The following global options control package behavior:

  • Rdatasets_cache: Logical

    • Whether to cache downloaded data and index for faster subsequent access. Default: TRUE. Please keep this option TRUE as it makes repeated access faster and avoids overloading the Rdatasets server. Only set to FALSE if local memory is severely limited.

    • Ex: 'options(Rdatasets_cache = TRUE)“

  • Rdatasets_class: String

    • Output class of the returned data. One of "data.frame" (default), "tibble", or "data.table". Default: "data.frame". Requires the respective packages to be installed for "tibble" or "data.table" formats.

    • Ex: options(Rdatasets_class = "tibble")

  • Rdataset_path: String.

    • Base URL for the Rdatasets archive. Default: "https://vincentarelbundock.github.io/Rdatasets/". Advanced users can set this to use a different mirror or local copy.

    • Ex: options(Rdataset_path = "https://vincentarelbundock.github.io/Rdatasets/")

Examples

idx <- rdindex()
head(idx)

Rdatasets documentation built on June 8, 2025, 11:48 a.m.