TargomoR (version 0.2.0)

capabilities: Get Account Capabilities

Description

Function to return a list of the capabilities of the API Key. Comes with a print method to print out the main results nicely in the console.

Usage

getTargomoCapabilities(api_key = Sys.getenv("TARGOMO_API_KEY"),
  region = Sys.getenv("TARGOMO_REGION"), config = list(),
  verbose = FALSE, progress = FALSE)
# S3 method for tgm_capabilities
print(x, ...)

Arguments

api_key

Your Targomo API key - defaults to the TARGOMO_API_KEY ennvironment variable

region

Your Targomo region - defaults to the TARGOMO_REGION environment variable

config

Config options to pass to httr::GET e.g. proxy settings

verbose

Whether to print out information about the API call.

progress

Whether to show a progress bar of the API call.

x

A list, output of getTargomoCapabilities

...

Further arguments to print

Value

A list of the capabilities of the given API key, in the given region

Examples

# NOT RUN {
caps <- getTargomoCapabilities()

# print default
print.default(caps)

# print using bespoke method
print(caps)
# }
# NOT RUN {
# }