Rmonkey-package: A Survey Monkey R Client

In leeper/Rmonkey: A Survey Monkey R Client

Description

Rmonkey provides access to Survey Monkey, for the complete integration of survey data collection and analysis into a single, easily reproducible workflow.

Details

To use Rmonkey, the user must have a Survey Monkey account, a Mashery Survey Monkey Developer account, and a registered API application. To create a Survey Monkey account, visit https://www.surveymonkey.com/user/sign-in/. To create a Mashery developer account, visit https://developer.surveymonkey.com/. Once registered, it is relatively easy to obtain an API key and secret client ID. It is then also possible to register an API application. This requires a name, OAuth redirect URL, and a brief description. In order to use Rmonkey, the redirect url must be registered as http://localhost:1410.

Once everything is registered, the relevant variables can be loaded into R using options:

options(sm_api_key = 'YourAPIKey') options(sm_secret = 'YourAPISecret') options(sm_client_id = 'YourMasheryDeveloperUsername')

Rmonkey uses these values inside smlogin to initiate an OAuth2.0 login. Calling smlogin, you will redirected to your web browser, where you will login with your regular Survey Monkey account information. smlogin will then store a durable OAuth token in options('sm_oauth_token'), which is automatically retrieved in subsequent Rmonkey operations. If you have trouble logging in, it is also possible to generate an OAuth token using the API Console, which can then be manually stored in options('sm_oauth_token').

Author(s)

Thomas J. Leeper

Maintainer: Thomas J. Leeper <[e-mail]>

References

API Documentation

Documentation of variable values used in responses

leeper/Rmonkey documentation built on May 21, 2019, 12:36 a.m.