show_all_metadata: Show a metadata cartesian product of all metadata present...

In DEIB-GECO/RGMQL: GenoMetric Query Language for R/Bioconductor

Show a metadata cartesian product of all metadata present into the dataset and the region sets

Description

It show the presence of the metadata keys in that specific regions set, showing its value or just the logical value TRUE.

Usage

show_all_metadata(dataset, show_value = FALSE)

Arguments

dataset	string with GMQL dataset folder path or remote dataset. In case of remote dataset to distinguish among private or public repository each name must be prefixed with "private." or "public." respectively.
show_value	whether or not show the value associated to metadata, otherwise only logical value (TRUE or FALSE) are shown.

Value

A Dataframe containing the mapping between metadata and the regions set

See Also

show_all_metadata

Examples

## This statement defines the path to the sub-directory "example" of the 
## package "RGMQL" and show all the metadata inside the GMQL dataset among
## all the meta files and return a data-frame, viewing as logical value 
## representing its presence or not for each region set.

test_path <- system.file("example", "DATASET", package = "RGMQL")
show_all_metadata(test_path)

## This statement defines the path to the sub-directory "example" of the 
## package "RGMQL" and show all the metadata inside the GMQL dataset among
## all the meta files and return a data-frame, viewing also its value.

test_path <- system.file("example", "DATASET", package = "RGMQL")
show_all_metadata(test_path, show_value = TRUE)

## This statement the remote dataset called "Example_Dataset_1" on public
## repository and show all the metadata inside the GMQL dataset among
## all the meta files and return a data-frame, viewing also its value.

test_url = "http://www.gmql.eu/gmql-rest"
login_gmql(test_url)
show_all_metadata("public.Example_Dataset_1", show_value = TRUE)

DEIB-GECO/RGMQL documentation built on Feb. 17, 2024, 10:39 p.m.