-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathshow_all_metadata.Rd
54 lines (46 loc) · 1.96 KB
/
show_all_metadata.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/show_all_metadata.R
\name{show_all_metadata}
\alias{show_all_metadata}
\title{Show a metadata cartesian product of all metadata present into the
dataset and the region sets}
\usage{
show_all_metadata(dataset, show_value = FALSE)
}
\arguments{
\item{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.}
\item{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
}
\description{
It show the presence of the metadata keys in that specific regions set,
showing its value or just the logical value TRUE.
}
\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)
}
\seealso{
\code{\link{show_all_metadata}}
}