microdemic-package: microdemic

In ropenscilabs/microdemic: 'Microsoft Academic' API Client

microdemic

Description

Microsoft Academic Client

Links

• web interface: https://academic.microsoft.com/

• API docs:

• https://docs.microsoft.com/en-us/academic-services/project-academic-knowledge/introduction

Package API

• ma_search()

• ma_calchist()

• ma_evaluate()

• ma_interpret()

• ma_abstract()

Authentication

See Microsoft Academic docs link above to get an API key. Make sure you enable Academic Knowledge. They should give you two API keys - use either one. You can always pass your API key as a parameter to functions in microdemic, but we strongly encourage you to set an environment variable, named MICROSOFT_ACADEMIC_KEY

To set the environment variable for the current R session only, run Sys.setenv(MICROSOFT_ACADEMIC_KEY = "yourkey"). Then microdemic will pick up this key and you do not have to pass your key as a parameter to the functions.

Even better, save your environment variable in the file that R will use to read in environment variables like MICROSOFT_ACADEMIC_KEY=yourkey. This may vary by system and machine. See ?Startup for details. It's likely your .Renviron file that is stored in your home directory. Or could be another environment variable holding file like .zshrc or .bash_profile. After saving the file, make sure to quit R, source that file like source .Renviron, then start R again. Or restart your RStudio session or similar for other R scenarios.

Rate limits

• 10,000 transactions per day

• 3 per second for interpret

• 1 per second for evaluate

• 6 per minute for calcHistogram

Author(s)

Scott Chamberlain

ropenscilabs/microdemic documentation built on Sept. 9, 2022, 5:42 p.m.