listOMLRunEvaluations: List run results of a task.

Description Usage Arguments Value Note Examples

View source: R/listOMLRunEvaluations.R

Description

Retrieves all run results for task(s) (task.id), flow(s) (flow.id) run(s) (run.id) or uploaders(s) (uploader.id and returns a data.frame. Each row contains, among others, the run id “rid”. Alternatively the function can be passed a single tag to list only runs with the corresponding tag associated.

Usage

1
2
3
4
listOMLRunEvaluations(task.id = NULL, flow.id = NULL, run.id = NULL,
  uploader.id = NULL, tag = NULL, limit = NULL, offset = NULL,
  verbosity = NULL, evaluation.measure = NULL,
  show.array.measures = FALSE, extend.flow.name = TRUE)

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.

evaluation.measure

[character(1)]
Use this to speedup your request. It restricts the results to only one evaluation measure (see listOMLEvaluationMeasures for possible values). Default is NULL, which means that no restriction is going to happen and all possible evaluation measures will be returned.

show.array.measures

[logical(1)]
Should measures that return an array instead of a single skalar value be shown (e.g. confusion matrix, predictive accuracy within each class)? Default is FALSE.

extend.flow.name

[logical(1)]
Adds a column flow.version that refers to the version number of the flow and a column flow.source containing the prefix of the flow that specifies the source of the flow (i.e. weka, R) and a column learner.name that refers to the learner. Default is TRUE.

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.

Examples

1
2
3
4
5
6
7
8
9
# \dontrun{
# 	# get run results of task 6 (as many rows as runs for this task)
# 	rev_tid6 = listOMLRunEvaluations(task.id = 6L)
# 	str(rev_tid6)
#
# 	# get run results of run 8 (one row)
# 	rev_rid8 = listOMLRunEvaluations(run.id = 8)
# 	str(rev_rid8)
# }

openml/openml-r documentation built on Nov. 23, 2018, 5:45 a.m.