dsApiRequest: Gather bibliographic records using Digital Science Dimensions...

In dimensionsR: Gathering Bibliographic Records from 'Digital Science Dimensions' Using 'DSL' API

Gather bibliographic records using Digital Science Dimensions API

Description

It gathers bibliographic records from Digigtal Science Dimensions. The function dsApiRequest queries Dimensions using a DSL query formulated through the function dsQueryBuild.

Usage

dsApiRequest(
  token,
  endpoint = "https://app.dimensions.ai/api/dsl.json",
  query,
  step = 100,
  limit = 50000,
  verbose = FALSE
)

Arguments

token	is a character. It contains a valid token to query Dimensions database through DSL API. The token can be obtain using the function dsAuth with valid credentials (account and password) .
endpoint	is a character. It contains the endpoint url of Dimensions API. Default is endpoint = "https://app.dimensions.ai/api/dsl.json".
query	is a character. It contains a search query formulated using the DSL API language. A query can be automatically generated using the function dsQueryBuild.
step	is integer. It indicates the number of records to download at each API request. Default is step = 100.
limit	is integer. It indicates the max number of records to download. limit cannot be higher than 50.000 (as stated by Dimensions rules).
verbose	is logical.

Value

a list cointaining bibliographic metadata downloaded from Dimensions.

To obtain a free access to Dimenions API for no commercial use, please visit: https://ds.digital-science.com/NoCostAgreement

For more extensive information about dimensions API, please visit: https://www.dimensions.ai/dimensions-apis/

See Also

dsQueryBuild

dsAuth

dsApi2df

Examples

## Not run: 
token <- dsAuth(username = "[e-mail]", password = "mypassword")
query <- dsQueryBuild(item = "publications", words = "bibliometric*", 
                       type = "article", categories = "management", 
                       start_year=1980,end_year = 2020)
D <- dsApiRequest(token = token, query = query, limit = 50000)

## End(Not run)

dimensionsR documentation built on March 18, 2022, 7:24 p.m.