gigwa_get_metadata: Get the metadate of the current active GIGWA run

View source: R/qbms.R

gigwa_get_metadataR Documentation

Get the metadate of the current active GIGWA run

Description

This function will retrieve the metadata of the current active run as configured in the internal state object using 'gigwa_set_run()' function.

Usage

gigwa_get_metadata()

Value

a data.frame of all metadata associated to the samples in the selected run

Author(s)

Khaled Al-Shamaa, k.el-shamaa@cgiar.org

See Also

set_qbms_config, gigwa_set_run

Examples

if(interactive()) {
# config your GIGWA connection
set_qbms_config("https://gigwa.southgreen.fr/gigwa/", 
                time_out = 300, engine = "gigwa", no_auth = TRUE)

# select a database by name
gigwa_set_db("3kG_10M")

# select a project by name
gigwa_set_project("3003_ind")

# select a specific run by name
gigwa_set_run("1")

# get a list of all samples in the selected run
metadata <- gigwa_get_metadata()
}

khaled-alshamaa/QBMS documentation built on Jan. 27, 2024, 6:40 a.m.