Analytics API Engines R SDK

Use this library to integrate with FactSet's Analytics APIs. Below APIs are supported by this SDK.

• PA Engine API
• SPAR Engine API
• Vault API

Contents

• auto-generated-sdk - Auto-generated code using Analytics API Engines SDK Generator
• examples - Sample project containing code snippets to quickly get started with the SDK
• tests - Integration tests

Requirements

• R-3.5.3 or higher

Installation

• Install from CRAN:

  Rscript -e "install.packages('factset.analyticsapi.engines', repos = 'http://cran.us.r-project.org')"

• Alternatively, download or clone this repository and build the SDK:

  git clone https://github.com/factset/analyticsapi-engines-r-sdk.git
  R CMD build auto-generated-sdk

Usage

Refer examples project for sample code snippets to quickly get started with the SDK

Tests

Prerequisite

testthat - For running end-to-end tests

Running the tests using RStudio

• Open RStudio and open a new R script.

• Set the working directory to the analyticsapi-engines-r-sdk directory using the setwd() command.

setwd("/path/to/analyticsapi-engines-r-sdk")

• Set the environment variables as below. Use the Developer Portal Manage API Keys page to get these values.

Sys.setenv("ANALYTICS_API_URL" = "https://api.factset.com")
Sys.setenv("ANALYTICS_API_USERNAME_SERIAL" = "<username-serial>")
Sys.setenv("ANALYTICS_API_PASSWORD" = "<apikey>")

Contributing

• Files in auto-generated-sdk directory are auto-generated and should not be manually edited here. Refer Analytics API Engines SDK Generator for instructions on how to modify these files.
• Projects examples and tests are open to enhancements and bug fixes. Please create a pull requests with the proposed changes.