medrxivr (version 0.1.3)

mx_snapshot: Access a static snapshot of the medRxiv repository

Description

[Available for medRxiv only] This function allows users to import a maintained static snapshot of the medRxiv repository, instead of downloading a copy from the API, which can become unavailable during peak usage times. The function reads a manifest-driven snapshot artifact from the package's GitHub release assets by default.

Usage

mx_snapshot(
  commit = "main",
  from_date = NULL,
  to_date = NULL,
  manifest_url = default_snapshot_manifest_url(),
  cache = TRUE
)

Value

A formatted dataframe containing the data from the snapshot artifact, with reconstructed `link_page` and `link_pdf` columns.

Arguments

commit

Deprecated. Only the default value "main" is supported. Use `manifest_url` to read a specific snapshot manifest.

from_date

Optional earliest date of interest ("YYYY-MM-DD" or Date). If supplied, records with `date` earlier than this are excluded.

to_date

Optional latest date of interest ("YYYY-MM-DD" or Date). If supplied, records with `date` later than this are excluded.

manifest_url

URL for a JSON snapshot manifest. Defaults to option `medrxivr.snapshot_manifest`, or the package's latest GitHub release manifest if that option is unset.

cache

Logical. If TRUE, downloaded manifest snapshot files are cached between sessions. Defaults to TRUE.

See Also

Other data-source: mx_api_content(), mx_api_doi()