show_schema: Show dataset schema

View source: R/web-services.R

show_schemaR Documentation

Show dataset schema

Description

It shows the region attribute schema of a specific GMQL dataset on remote repository, using the proper GMQL web service available on a remote server

Usage

show_schema(url, datasetName)

Arguments

url

string url of server: It must contain the server address and base url; service name is added automatically

datasetName

name of dataset to get the schema; if the dataset is a public dataset, we have to add "public." as prefix, as shown in the example below, otherwise no prefix is needed

Details

If error occurs, a specific error is printed

Value

List of region schema fields. Every field in the list is described by:

  • name: name of field (e.g. chr, start, end, strand, ...)

  • fieldType: (e.g. STRING, DOUBLE, ...)

Examples

## Login to GMQL REST services suite as guest

remote_url = "http://www.gmql.eu/gmql-rest/"
login_gmql(remote_url)

## Show schema of public dataset 'Example_Dataset_1'

list <- show_schema(remote_url, "public.Example_Dataset_1")


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