textaInit: Initializes the 'mscstexta4r' package.

In mscstexta4r: R Client for the Microsoft Cognitive Services Text Analytics REST API

Description

This function initializes the Microsoft Cognitive Services Text Analytics REST API key and URL by reading them either from a configuration file or environment variables.

This function MUST be called right after package load and before calling any mscstexta4r core functions, or these functions will fail.

The textaInit configuration function will first check to see if the variable MSCS_TEXTANALYTICS_CONFIG_FILE exists in the system environment. If it does, the package will use that as the path to the configuration file.

If MSCS_TEXTANALYTICS_CONFIG_FILE doesn't exist, it will look for the file .mscskeys.json in the current user's home directory (that's ~/.mscskeys.json on Linux, and something like C:/Users/Phil/Documents/.mscskeys.json on Windows). If the file is found, the package will load the API key and URL from it.

If using a file, please make sure it has the following structure:

{
  "textanalyticsurl": "https://westus.api.cognitive.microsoft.com/texta/analytics/v2.0/",
  "textanalyticskey": "...MSCS Text Analytics API key goes here..."
}

If no configuration file is found, textaInit will attempt to pick up its configuration information from two Sys env variables instead:

MSCS_TEXTANALYTICS_URL - the URL for the Text Analytics REST API.

MSCS_TEXTANALYTICS_KEY - your personal Text Analytics REST API key.

textaInit needs to be called only once, after package load.

Usage

textaInit()

Author(s)

Phil Ferriere [e-mail]

Examples

## Not run: 
 textaInit()

## End(Not run)

mscstexta4r documentation built on May 1, 2019, 9:16 p.m.