getAlgorithmiaClient {algorithmia}R Documentation

Creates a new Algorithmia Client which you can use to call algorithms and interact with directories and files in the Algorithmia data API.

Description

Creates a new Algorithmia Client which you can use to call algorithms and interact with directories and files in the Algorithmia data API.

Usage

getAlgorithmiaClient(apiKey = NA_character_, apiAddress = NA_character_)

Arguments

apiKey

The Algorithmia API key. You need to set this when you are interacting with Algorithmia outside of an algorithm. To find your Algorithmia API key visit: https://algorithmia.com/users/[YOUR USER NAME]

apiAddress

The Algorithmia API address. Normal users should not set this. This defaults to "https://api.algorithmia.com" when it is not explicitly set.

Value

A new AlgorithmiaClient object

Examples

client <- algorithmia::getAlgorithmiaClient() # Inside an Algorithmia algorithm
client <- algorithmia::getAlgorithmiaClient("YOUR_ALGORITHMIA_API_KEY") # Everywhere else

[Package algorithmia version 0.3.0 Index]