getOMLDataSet: Get an OpenML data set.

In openml/openml-r: Open Machine Learning and Open Data Platform

Get an OpenML data set.

Description

Given a data set ID, the corresponding OMLDataSet will be downloaded (if not in cache) and returned.

Note that data splits and other task-related information are not included in an OMLDataSet. Tasks can be downloaded with getOMLTask.

Usage

getOMLDataSet(
  data.id = NULL,
  data.name = NULL,
  data.version = NULL,
  cache.only = FALSE,
  verbosity = NULL
)

Arguments

data.id	[integer(1)] ID of the data set.
data.name	[character(1)] Data set name. This is an alternative to data.id. Default is NULL.
data.version	[integer(1)] Version number of the data set with name data.name. Default is NULL. Ignored if data.id is passed.
cache.only	[logical(1)] Only try to retrieve the object from cache. Will result in error if the object is not found. Default is FALSE.
verbosity	[integer(1)] Print verbose output on console? Possible values are: 0: normal output, 1: info output, 2: debug output. Default is set via setOMLConfig.

Value

[OMLDataSet].

Note

One of data.id or data.name must be passed.

See Also

Other downloading functions: getOMLDataSetQualities(), getOMLFlow(), getOMLRun(), getOMLStudy(), getOMLTask()

Other data set-related functions: OMLDataSetDescription, OMLDataSet, convertMlrTaskToOMLDataSet(), convertOMLDataSetToMlr(), deleteOMLObject(), listOMLDataSets(), tagOMLObject(), uploadOMLDataSet()

Examples

# \dontrun{
# 	dat = getOMLDataSet(data.id = 9)
#
# 	# this object contains the data ($data)
# 	# and meta information
# 	str(dat, 1)
# 	summary(dat$data)
# }

openml/openml-r documentation built on June 4, 2024, 12:11 a.m.