Skip to contents

Access a static snapshot of the medRxiv repository

Source: R/mx_snapshot.R
mx_snapshot.Rd

[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 dynamically retrieves multiple snapshot parts from the specified repository and combines them into a single dataframe.

Usage

mx_snapshot(commit = "main")

Arguments

commit

Commit hash or branch name for the snapshot, taken from https://github.com/yaoxiangli/medrxivr-data. Allows for reproducible searching by specifying the exact snapshot used to perform the searches. Defaults to "main", which will return the most recent snapshot from the main branch.

Value

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

See also

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

Examples

# \donttest{
mx_data <- mx_snapshot()
mx_data_specific <- mx_snapshot(commit = "specific_commit_hash")
#> Warning: cannot open URL 'https://api.github.com/repos/YaoxiangLi/medrxivr-data/contents/?ref=specific_commit_hash': HTTP status was '404 Not Found'
#> Error in value[[3L]](cond): Failed to retrieve file list from GitHub. Please check the commit or branch name.
# }