vortx_info: Get information

Description Usage Arguments Value Examples

Description

Gets information on a VORTX job

Usage

1
vortx_info(key, job, info = "all")

Arguments

key

String. User API Key for VORTX.

job

String or List. Can be either a job ID number in string format or parsed JSON in list format, result of organizer or discoverer functions.

info

String. Defines what kind of information to be extracted from job, between 'clusters', 'varscores', 'dataset' or 'summary'. Default is 'all'.

Value

List of DataFrames or DataFrame. If 'all' or 'summary' are defined, a list. Else specific DataFrame.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
## Not run: 
mykey <- '1234567890abcefghijkl'
myjobid <- '0987654321'

myjobname <- 'My job'
myjobdesc <- 'This is a job that does job stuff'
df <- data.frame(c(1,2,3), c(4,5,6), c(7,8,9))
myjob <- vortx_create_job(mykey, df, myjobname, myjobdesc)

vortx_info(mykey, myjobid, info = 'clusters')
vortx_info(mykey, myjob)

## End(Not run)

Aquarela-Advanced-Analytics/r2vortx documentation built on May 20, 2019, 8:46 a.m.