loadExampleData: Access example data

View source: R/loadExampleData.R

loadExampleDataR Documentation

Access example data

Description

Make example data available, typically for use in teaching.

Usage

loadExampleData(name = "list", envir = globalenv(), verbose = TRUE)

Arguments

name

An optional character scalar specifying the data set(s) to be made available. The special name "list" (default) is used to print a data frame of available data sets with descriptions. The special name "latest" will select the latest data set(s) available.

envir

specifies the environment in which the data should be made available. By default, envir = globalenv(), which creates the example data objects in the user workspace. Possible alternative environment are for example parent.frame(), which is the environment in which loadExampleData() was called.

verbose

A logical scalar. If TRUE, report what is being selected and made available.

Value

A data.frame (invisibly) with one row for each dataset that was made available in the global environment.

Author(s)

Michael Stadler

Examples

loadExampleData()
loadExampleData("mycars")


fmicompbio/swissknife documentation built on June 11, 2025, 4:17 p.m.