get_ph_metadata: Import meta data from various PureHoney files.

In hemoshear/assayr2: Tools for analyzing assay data

Description

Reads meta data from sample databases on Box via boxr::box_read()

Usage

get_ph_metadata(study_id, device = FALSE, fully_parse = TRUE)

Arguments

study_id	Character in the standard study name format (i.e. "RNO0101-1" or "RNO0101").
device	Boolean, is this a device experiment? Only used for 'RNO' projects.
fully_parse	Logical indicating whether to try and filter the database to a specific run; Set FALSE to troubleshoot.

Details

Requires a column named STUDY NAME that contains the study ID in the Excel file being read, in order to use the fully_parse option to work properly. PAH experiments were originally recorded in box_file 101838632791 until November 2018. In order to access these older projects adjust the study ID to be 'PAHO'.

Value

A data frame containing the meta information from a given study or all the meta information from all studies in a program.

Examples

## Not run: 
## Requires boxR credentials
# returns only meta data from study RNO0738
meta <- get_ph_metadata("RNO0738")
# returns all studies' meta data from RNO07 project
all_meta <- get_ph_metadata("RNO0738", fully_parse = F)

## End(Not run)

hemoshear/assayr2 documentation built on Nov. 8, 2019, 6:13 p.m.