getOMLRun: Get an OpenML run.

View source: R/getOMLRun.R

getOMLRunR Documentation

Get an OpenML run.

Description

Given an run id, the corresponding OMLRun including all server and user computed metrics is downloaded if not already available in cache.

Usage

getOMLRun(run.id, cache.only = FALSE, only.xml = FALSE, verbosity = NULL)

Arguments

run.id

[integer(1)]
The run ID.

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.

only.xml

[logical(1)]
Should only the XML be downloaded?

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

[OMLRun].

See Also

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

Other run-related functions: convertOMLMlrRunToBMR(), convertOMLRunToBMR(), deleteOMLObject(), listOMLRuns(), makeOMLRunParameter(), makeOMLRun(), tagOMLObject(), uploadOMLRun()

Examples

# \dontrun{
# 	runs_ctree = listOMLRuns(flow.id = 2569)
# 	run1 = getOMLRun(run.id = runs_ctree$run.id[1])
# 	str(run1, 1)
# }

OpenML documentation built on Oct. 20, 2022, 1:07 a.m.