fetch_zotero_refs: Save a collection from a Zotero-Account to a BibTeX-file...

View source: R/deprecated_defunct.R

fetch_zotero_refsR Documentation

Save a collection from a Zotero-Account to a BibTeX-file (defunct)

Description

Downloads and saves a Zotero reference library (or a subset) and saves it as BibTeX file. This function has been defunct. Use ReadZotero() from the RefManageR package instead.

Usage

fetch_zotero_refs(
  x,
  bib_name,
  API_key = NULL,
  collection = NULL,
  lib_type = "user"
)

Arguments

x

Character. Zotero user or group ID, see details.

bib_name

Character. Name of the BibTeX-file references are saved to.

API_key

Character. Zotero API key, see details.

collection

Character. Optional ID of a collection in the Zotero library, see details.

lib_type

Character. Specifies if the supplied ID is associated with a Zotero user or group.

Details

This function retrieves references through the Zotero web API. x takes a Zotero user or group ID that can be retrieved from the Zotero.org user or group Feeds/API settings. An authentication key (API_key) is required to access nonpublic Zotero libraries. Authentication keys can also be generated in the Zotero.org user or group Feeds/API settings.

If the requested reference collection is larger than 100 records, multiple API calls are initiated because the number of retrieved records is limited to 100 per API call. Frequent API calls will result in a temporary access block. Thus, there is an (currently unknown) upper limit to the length of reference collections that can be retrieved through this function. It is generally recommended to comment out calls to this function in R Markdown documents during periods of frequent knitting to limit the number of API calls and limit the number of references to those needed for the current document by setting up collections in your Zotero library.

Collection keys (collection), i.e. identifiers of reference library subsets, can be retrieved by accessing them via a web browser. They keys are contained in the URL:

⁠https://www.zotero.org/<USERNAME>/items/collectionKey/<COLLECTIONKEY>⁠

Zotero web API calls can be slow, especially for large reference collections. If available, this function will use the downloader-package, which speeds up reference downloads considerably.

Value

Returns bib_name invisibly.

Author(s)

Christoph Stahl, Frederik Aust

See Also

cite_r(), r_refs()


papaja documentation built on Oct. 30, 2024, 9:09 a.m.