traverse_paper: Traversing the literature graph of a paper's information

View source: R/semantic_scholar.R

traverse_paperR Documentation

Traversing the literature graph of a paper's information

Description

This function fetch details about the papers the cite this paper (i.e. papers in whose bibliography this paper appears) and cited by this paper (i.e. appearing in this paper's bibliography)

Usage

traverse_paper(
  paper_id,
  offset = 0,
  limit = 100,
  type = "citations",
  fields = NULL
)

Arguments

paper_id

string Supported paper identifier services: Semantic Scholar ID, Semantic Scholar numerical ID, Digital Object Identifier, arXiv.rg, Microsoft Academic Graph, Association for Computational Linguistics, PubMed/Medline, PubMed Central and URL from one of the sites listed below. See Format for detalis.

offset

integer Default: 0. When returning a list of results, start with the element at this position in the list.

limit

integer Default: 100. The maximum number of results to return. The sum of offset and limit must be < 10000.

type

string Supported paper query services: "authors","citations", OR "references".

fields

string A comma-separated list of the fields to be returned, support one or more fileds, for example fileds = get_fields()[['paper_citation']] for "citations" was all fields to be returned. See Format or see get_fields to set more params.

Format

The following types of paper_id are supported:

  • <sha> - a Semantic Scholar ID, e.g. 649def34f8be52c8b66281af98ae884c09aef38b

  • CorpusId:<id> - Semantic Scholar numerical ID, e.g. 215416146

  • DOI:<doi> - a Digital Object Identifier, e.g. DOI:10.18653/v1/N18-3011

  • ARXIV:<id> - arXiv.rg, e.g. ARXIV:2106.15928

  • MAG:<id> - Microsoft Academic Graph, e.g. MAG:112218234

  • ACL:<id> - Association for Computational Linguistics, e.g. ACL:W12-3903

  • PMID:<id> - PubMed/Medline, e.g. PMID:19872477

  • PMCID:<id> - PubMed Central, e.g. PMCID:2323736

  • URL:<url> - URL from one of the sites listed below, e.g. URL:https://arxiv.org/abs/2106.15928v1

Details

See website https://api.semanticscholar.org/graph/v1#operation/get_graph_get_paper_authors for details.

Value

list representing paper objects

Author(s)

Liuyong Ding

Examples

## Not run: 
res <- traverse_paper(paper_id = "649def34f8be52c8b66281af98ae884c09aef38b")

## End(Not run)

Otoliths/S2miner documentation built on Dec. 5, 2023, 2:17 p.m.