flickr: R functions interfacing to Flickr API operations

Description Value

Description

These functions in R provide a one-to-one correspondence with the Flickr API operations documented at http://www.flickr.com/services/api/. That is the place to read about the operations, their parameters and the result. These functions take care of collecting the arguments, submitting the request, and processing the XML result.

The function flickrSession provides a much more convenient way to invoke these functions without having to explicitly pass the api_key, secret and auth_token arguments in each call. Also, it provides a short-hand way to refer to the functions, i.e. without the flickr.auth. prefix.

These functions were generated programmatically by reading the HTML documents on the Flickr site using the XML package and determining the names of the operations and their parameters and whether they are required or optional. The code to generate the function code is in the package, but not exported via the NAMESPACE. It is available to be consulted and/or enhanced, e.g. to add the format parameter to allow the caller to get the result as a JSON formatted value.

Value

The result depends on the function. If an error occurs in the Flickr operation, an error is thrown in R. This is a customized condition and so can be caught using tryCatch.


duncantl/Rflickr documentation built on May 15, 2019, 5:54 p.m.