doAPICall: Perform an API call to the OpenML server.

Description Usage Arguments Value

View source: R/download.R

Description

The function always returns the XML file content provided by the server.

Usage

1
2
doAPICall(api.call, id = NULL, url.args = list(), post.args = list(),
  file = NULL, verbosity = NULL, method, ...)

Arguments

api.call

[character(1)]
API endpoints listed in APIv1.

id

[integer(1)]
Optional ID we pass to the API, like runs/list/1.

url.args

[list]
Named list of key-value pairs passed as HTTP GET parameters, e.g., key1=value1&key2=value2 to the API call.

post.args

[list]
Optional. A list passed to the body-arg for POST requests.

file

[character(1)]
Optional filename to write the XML content to.

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.

method

[character(1)]
HTTP request method. Currently one of GET, POST or DELETE.

...

Another possibility to pass key-value pairs for the HTTP request query. Arguments passed via ... have a higher priority.

Value

[character(1)]
Unparsed content of the returned XML file.


OpenML documentation built on Sept. 21, 2019, 5:02 p.m.