puremoe (version 1.0.3)

data_pmc_list: Download and Load 'PMC' Open Access File List

Description

This function downloads and loads the 'PMC' (PubMed Central) Open Access file list. The file list contains mappings between PMC IDs, PMIDs, and file paths for open access articles available for download.

Usage

data_pmc_list(
  path = NULL,
  use_persistent_storage = FALSE,
  force_install = FALSE
)

Value

A data.table containing the PMC file list with columns: file_path, citation, pmcid, pmid, and license_code.

Arguments

path

A character string specifying the directory path where data should be stored. If not provided and persistent storage is requested, it defaults to a system-appropriate persistent location managed by `rappdirs`.

use_persistent_storage

A logical value indicating whether to use persistent storage. If TRUE and no path is provided, data will be stored in a system-appropriate location. Defaults to FALSE, using a temporary directory.

force_install

A logical value indicating whether to force re-downloading of the data even if it already exists locally.

Details

The data is sourced from NCBI's FTP server and stored locally for subsequent use. By default, the data is stored in a temporary directory. Users can opt into persistent storage by setting `use_persistent_storage` to TRUE and optionally specifying a path.

Examples

# \donttest{
if (interactive()) {
  data <- data_pmc_list()
}
# }