readLipd: Read LiPD files into R workspace

View source: R/init.R

readLipdR Documentation

Read LiPD files into R workspace

Description

Read LiPD files into R workspace

Usage

readLipd(path = NULL, jsonOnly = FALSE, parallel = FALSE)

Arguments

path

A string specifying a file, url, or directory, or a vector of strings specifying files or urls. Alternatively, no entry (default) will open a selection windw..

jsonOnly

Load data from json only (not lpd file? Typically only used for web connections)

parallel

load data in parallel? Default = FALSE. Can greatly increase load time for large collections of data. Uses furrr, so you'll need to run future::plan() before calling the function. e.g. 'future::plan(multisession,workers = 8)'

Value

D : LiPD dataset(s)

Author(s)

Chris Heiser

Nick McKay

Examples

## Not run: 
#' read in multiple datasets - no path argument
D <- readLipd()   # choose option 'd' for directory

read in multiple datasets - with path argument
D <- readLipd("/Users/bobsmith/Desktop/lipd_files")

read in one dataset - no path argument
L <- readLipd()  # choose option "s" for single file

read in one dataset - with path argument
L <- readLipd("/Users/bobsmith/Desktop/lipd_files/dataset.lpd")

## End(Not run)

nickmckay/lipdR documentation built on April 13, 2025, 5:58 p.m.