search_references: Query references

In mangal-wg/rmangal: 'Mangal' Client

Query references

Description

Search for a specific reference using a key word or a Digital Object Identifier (DOI). If the query is a character string, then all character columns in the table are searched and the entries for which at least one partial match was found are returned. Alternatively, a named list can be used to look for an exact match in a specific column (see Details section).

Usage

search_references(query, doi = NULL, verbose = TRUE, ...)

Arguments

query	either a character string including a single keyword or a named list containing a custom query (see details section below). Note that if an empty character string is passed, then all datasets available are returned.
doi	character a Digital Object Identifier (DOI) of the article. Note that query is ignored if doi is specified.
verbose	a logical. Should extra information be reported on progress?
...	further arguments to be passed to httr::GET().

Details

Names of the list should match one of the column names within the table. For the reference table, those are:

• id: unique identifier of the reference

• first_author: first author

• doi: use doi instead

• jstor: JSTOR identifier

• year: year of publication.

Note that for lists with more than one element, only the first element is used, the others are ignored. An example is provided below.

Value

An object of class mgSearchReferences, which is a list that includes a wide range of details associated to the reference, including all datasets and networks related to the publication that are included in Mangal database.

References

• https://mangal.io/#/

• https://mangal-interactions.github.io/mangal-api/#references

Examples

 search_references(doi = "10.2307/3225248")
 search_references(list(jstor = 3683041))
 search_references(list(year = 2010))

mangal-wg/rmangal documentation built on Jan. 15, 2024, 10:23 p.m.