Skip to contents

Download and Read Datasets from marginaleffects or Rdatasets

Source: R/get_dataset.R
get_dataset.Rd

Downloads a dataset from the marginaleffects or the Rdatasets archives, and return it as a data frame. Opens the documentation as an HTML page. Search available datasets.

https://vincentarelbundock.github.io/Rdatasets/

Usage

get_dataset(dataset = "thornton", package = NULL, docs = FALSE, search = NULL)

Arguments

dataset

String. Name of the dataset to download.

  • marginaleffects archive: affairs, airbnb, ces_demographics, ces_survey, immigration, lottery, military, thornton, factorial_01, interaction_01, interaction_02, interaction_03, interaction_04, polynomial_01, polynomial_02

  • Rdatasets archive: The name of a dataset listed on the Rdatasets index. See the website or the search argument.

package

String. Package name that originally published the data.

docs

Logical. If TRUE open the documentation using getOption("viewer") or the Rstudio viewer.

Regular expression. Download the dataset index from Rdatasets; search the "Package", "Item", and "Title" columns; and return the matching rows.

Value

A data frame containing the dataset.

Examples

if (FALSE) {
dat <- get_dataset("Titanic", "Stat2Data")
head(dat)

get_dataset(search = "(?i)titanic")

# View documentation in the browser
get_dataset("Titanic", "Stat2Data", docs = TRUE)
}