The Data Commons R API is a R library that enables developers to programmatically access nodes in the Data Commons knowledge graph. This package allows users to explore the structure of the graph, integrate statistics from the graph into data analysis workflows and much more. Please see the overview for more details on the design and structure of the API.
Before proceeding, make sure you have followed the setup instructions below.
To get started using the R API Client requires the following steps:
- Install the R API Client via
- Create an API key and enable the Data Commons API.
- Provide the API key to the R API Client and begin developing.
In the R console, install the
datacommons package using
# If devtools is not installed yet, install devtools if(!require(devtools)) install.packages("devtools") # Load devtools library(devtools) # Install the R API Client devtools::install_github("datacommonsorg/api-r@latest", subdir="datacommons")
Using the Data Commons R API Client requires you to setup access to the Data Commons API on Google Cloud Platform. Follow the setup guide here.
With the API key created and Data Commons API activated, we can now get started using the Data Commons R API Client.
You can set the API key by calling
set_api_key. Start by loading
datacommons, then set the API key like so:
This will create an environment variable in your R runtime called
DC_API_KEY holding your key. Your key will then be used whenever the package sends a request to the Data Commons graph.
You are now ready to go! From here you can view our tutorials on how to use the API to perform certain tasks, or see a full list of functions, classes and methods available for use below.