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

In puremoe: Pubmed Unified REtrieval for Multi-Output Exploration

Download and Process 'PMC Open Access' File List

Description

This function downloads the 'PubMed Central' (PMC) open access file list from the 'National Center for Biotechnology Information' (NCBI) and processes it for use.

Usage

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

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.
timeout	An integer indicating the timeout in seconds for the download. Defaults to 300 seconds.

Details

The data is sourced from the specified URL 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.

Value

A data frame containing the processed PMC open access file list.

Examples

if (interactive()) {
  data <- data_pmc_list()
}

puremoe documentation built on Oct. 16, 2024, 1:07 a.m.