get_recipes: Get a tibble of available recipes

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

Description

Default behavior is to just retrieve all active recipes, no matter on which instance they are running. You may change this behavior in two ways (or combinations thereof):

• If instance_uid is set, only recipes assigned to at least one of these instances are returned.

• If include_inactive is set to TRUE, also recipes currently not active are returned.

Usage

get_recipes(connection, instance_uid = NULL, include_inactive = FALSE)

Arguments

connection	A connection object, as retrieved from connect_scrapebot().
instance_uid	Numeric UID or a vector of numeric UIDs of the instance to filter recipes for. Filtering is inclusive (i.e., recipes are included if they are assigned to at least one of the instances; no need to be assigned to all of them to be returned). If NULL, all recipes are provided. Defaults to NULL.
include_inactive	If TRUE, inactive recipes are included along active recipes; defaults to FALSE.

Value

A tibble listing all available recipes including its UID, name, the date then the recipe was first created, its description, whether the recipe is active, as well as the number of its runs and the date of the latest run.

See Also

get_recipe_steps()

Examples

## Not run: 

connection <- connect('my_db on localhost')
get_recipes(connection)
get_recipes(connection, include_inactive = TRUE)
disconnect(connection)

## End(Not run)

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