show_samples_list: Show dataset samples

View source: R/web-services.R

show_samples_listR Documentation

Show dataset samples

Description

It show all samples from a specific GMQL dataset on remote repository, using the proper GMQL web service available on a remote server

Usage

show_samples_list(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 containing the samples whose list we like to get; 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 samples in dataset. Every sample in the list is described by:

  • id: id of sample

  • name: name of sample

  • path: sample repository path

Examples


## Login to GMQL REST services suite as guest

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

## This statement shows all samples present into public dataset 
## 'Example_Dataset_1'

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


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