pull_related_recs: Pull related records

In vt-arc/wosr: Clients to the 'Web of Science' and 'InCites' APIs

Pull related records

Description

Pull the records that have at least one citation in common with a publication of interest.

Usage

pull_related_recs(uts, num_recs, editions = c("SCI", "SSCI", "AHCI",
  "ISTP", "ISSHP", "BSCI", "BHCI", "IC", "CCR", "ESCI"),
  sid = auth(Sys.getenv("WOS_USERNAME"), Sys.getenv("WOS_PASSWORD")),
  ...)

Arguments

uts	The documents whose related records you want to pull.
num_recs	Number of related records to pull for each UT. This value must be <= 100.
editions	Web of Science editions to query. Possible values are listed here.
sid	Session identifier (SID). The default setting is to get a fresh SID each time you query WoS via a call to auth. However, you should try to reuse SIDs across queries so that you don't run into the throttling limits placed on new sessions.
...	Arguments passed along to POST.

Value

A data frame with the following columns:

ut

The publications that you passed into pull_related_recs. If one of your publications doesn't have any related records, it won't appear here.

related_rec

The publication that is related to ut.

rec_num

The related record's ordering in the result set returned by the API. Records that share more citations with your UTs will have smaller rec_nums.

Examples

## Not run: 

sid <- auth("your_username", password = "your_password")
uts <- c("WOS:000272877700013", "WOS:000272366800025")
out <- pull_related_recs(uts, 5, sid = sid)

## End(Not run)

vt-arc/wosr documentation built on Sept. 27, 2022, 5:44 a.m.