get_run_data: Collect (large amounts of) data for a given combination of...

In MarHai/ScrapeBotR: Orchestrate Instances and Retrieve Data from a ScrapeBot Database

Description

Data is stored heavily within ScrapeBot. Hence, filtering needs to be applied to collect data. Two types of filter are possible:

• Filter on the runs for which to collect data: Specify one or many of run_uid, instance_uid, and recipe_uid. At least one is required.

• Filter on the step for which to collect data: Optionally specify a step_uid. In general, this function only returns data from "success"-ful runs (see get_runs()). It then collects runs matching the first set of criteria (i.e., run_uid, instance_uid, and recipe_uid). Ultimately, it collects data, thereby focusing on a specific step if specified.

Usage

get_run_data(
  connection,
  run_uid = NULL,
  instance_uid = NULL,
  recipe_uid = NULL,
  step_uid = NULL
)

Arguments

connection	A connection object, as retrieved from connect_scrapebot().
run_uid	Optional numeric UID or a vector of numeric UIDs of a specific run to collect data from. If NULL, either instance_uid or recipe_uid (or both) has to be provided. Defaults to NULL.
instance_uid	Optional numeric UID or a vector of numeric UIDs of the instance to filter data for. If NULL, either run_uid or recipe_uid (or both) has to be provided. Defaults to NULL.
recipe_uid	Optional numeric UID or a vector of numeric UIDs of the recipe to filter data for. If NULL, either instance_uid or run_uid (or both) has to be provided. Defaults to NULL.
step_uid	Optional numeric UID or a vector of numeric UIDs of a step to filter data for. Defaults to NULL.

Value

A tibble listing all data including their creation timestamp, the UIDs of its run, instance, recipe, and step, as well as the data value itself.

See Also

get_runs(), get_run_log()

Examples

## Not run: 

connection <- connect('my_db on localhost')
get_run_data(connection, instance_uid = 42)
get_run_data(connection, run_uid = 256)
get_run_data(connection, recipe_uid = 21)
get_run_data(connection, run_uid = c(256, 1024))
get_run_data(connection, recipe_uid = 21:23)
get_run_data(connection, instance_uid = 42, recipe_uid = 21)
get_run_data(connection, instance_uid = 42, recipe_uid = 21, step_uid = 8)
disconnect(connection)

## End(Not run)

MarHai/ScrapeBotR documentation built on March 10, 2021, 10:10 a.m.