Skip to contents

Provides multiple outputs in one request

Source: R/request_blend.R
request_blend.Rd

Function request_blend() acts as a one-stop-shop to obtain multiple outputs through one request.

Usage

request_blend(
  txt = "",
  sitehost = "",
  session = "",
  blend = "standard",
  loc = "",
  ...
)

Arguments

txt

A JSON string, URL or file with the data in JSON format. The input data adhere to specification BDS JGZ 3.2.5, and are converted to JSON according to schema.

sitehost

The host that renders the site. Normally, that would be equal to the host on which JAMES runs. If not specified, the function throws a warning and sets sitehost to "http://localhost".

session

Alternative to txt. Session key where input data is uploaded on sitehost.

blend

A string indicating the requested blend. The default ("standard") returns the results of the standard end points that produces tables. Graphs are currently not supported.

loc

Alternative to txt. Location where input data is uploaded. Argument loc is deprecated and will disappear in Nov 2022; please use session instead.

...

Ignored

Value

The default blend = "standard" return a list with the following components:

txt

String, file or URL with child data

session

Session with uploaded child data

child

Processed child level data

time

Processed time level data

screeners

Results from application of screeners to child data

site

URL with personalised child data

Examples

if (FALSE) { # \dontrun{
fn <- system.file("extdata", "bds_v2.0", "smocc", "Laura_S.json", package = "jamesdemodata")
results <- request_blend(txt = fn)
} # }