search_ror: Get ROR

View source: R/search_ror.R

search_rorR Documentation

Get ROR

Description

Get ROR ID based on the organisation name.

Usage

search_ror(
  x,
  org.name = "OrganizationName",
  country.name = "CountryName",
  type = NULL,
  matching.type = NULL,
  rows = 1
)

Arguments

x

a data frame containing at least one column: the organization name

org.name

character. The name of the column containing the organization name. Defaults to "OrganizationName".

country.name

character. The name of the column containing the name of the organization country. Defaults to "CountryName".

type

character. The type of organizations for matching (see details)

matching.type

character. The type of match performed (see details)

rows

numerical. The row(s) number(s) to be returned up to 20. Default to the first one, which is the one with the best search score.

Details

This function queries the ROR API (https://ror.readme.io/docs/rest-api)

If not NULL, the argument type can be one of the following: Education, Healthcare, Company, Archive, Nonprofit, Government, Facility, and Other.

If not NULL, the argument matching.type can be one of the following:

  • PHRASE: the entire phrase matched to a variant of the organization's name

  • COMMON TERMS: the matching was done by comparing the words separately

  • FUZZY: the matching was done by fuzzy-comparing the words separately

  • HEURISTICS: "University of X" was matched to "X University"

  • ACRONYM: matching by acronym

Value

the same input data frame with the missing (i.e. NA) ORCID, and optionally the corresponding names, if found.

Author(s)

Renato A. F. de Lima

Examples


## Not run: 

  
  df <- data.frame(
  OrganizationName = c("USP", "Universidade de Sao Paulo", "USP"), 
  CountryName = c("Brazil", "Brazil", NA))
  search_ror(df)
  search_ror(df, matching.type = "ACRONYM")
  

## End(Not run)   
  

FRBCesab/authoR documentation built on July 12, 2022, 6:04 a.m.