listOMLRuns: List the first 5000 OpenML runs.

listOMLRunsR Documentation

List the first 5000 OpenML runs.

Description

This function returns information on all OpenML runs that match certain task.id(s), run.id(s), flow ID flow.id and/or uploader.id(s). Alternatively the function can be passed a single tag to list only runs with the corresponding tag associated. Note that by default only the first 5000 runs will be returned (due to the argument “limit = 5000”).

Usage

listOMLRuns(
  task.id = NULL,
  flow.id = NULL,
  run.id = NULL,
  uploader.id = NULL,
  tag = NULL,
  limit = 5000,
  offset = NULL,
  verbosity = NULL
)

Arguments

task.id

[integer]
a single ID or a vector of IDs of the task(s).

flow.id

[integer]
a single ID or a vector of IDs of the flow(s).

run.id

[integer]
a single ID or a vector of IDs of the run(s).

uploader.id

[integer]
a single ID or a vector of IDs of uploader profile(s).

tag

[character]
If not NULL only entries with the corresponding tags are listed.

limit

[numeric(1)]
Optional. The maximum number of entries to return. Without specifying offset, it returns the first 'limit' entries. Setting limit = NULL returns all available entries.

offset

[numeric(1)]
Optional. The offset to start from. Should be indices starting from 0, which do not refer to IDs. Is ignored when no limit is given.

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

[data.frame].

Note

This function is memoised. I.e., if you call this function twice in a running R session, the first call will query the server and store the results in memory while the second and all subsequent calls will return the cached results from the first call. You can reset the cache by calling forget on the function manually.

See Also

Other listing functions: chunkOMLlist(), listOMLDataSetQualities(), listOMLDataSets(), listOMLEstimationProcedures(), listOMLEvaluationMeasures(), listOMLFlows(), listOMLSetup(), listOMLStudies(), listOMLTaskTypes(), listOMLTasks()

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

Examples

# \dontrun{
#   runs_ctree = listOMLRuns(flow.id = 2569)
#   head(runs_ctree)
# }

openml/openml-r documentation built on Oct. 21, 2022, 2:16 a.m.