Recipe R6 class

R6 class representing a reproducible data transformation recipe for surveys. It encapsulates metadata, declared dependencies, and a list of transformation steps to be applied to a Survey object.

Format

An R6 class generator (R6ClassGenerator)

Value

An object of class Recipe.

Methods

$new(name, edition, survey_type, default_engine, depends_on, user, description, steps, id, doi, topic)

Class constructor.

$doc()

Auto-generate documentation from recipe steps. Returns a list with metadata, input_variables, output_variables, and pipeline information.

$validate(svy)

Validate that a survey object has all required input variables.

See also

recipe, save_recipe, read_recipe, bake_recipes

Other recipes: add_recipe(), bake_recipes(), get_recipe(), harmonize(), print.Recipe(), publish_recipe(), read_recipe(), recipe(), save_recipe(), steps_to_recipe()

Public fields

name

Descriptive name of the recipe (character).

edition

Target edition/period (character or Date).

survey_type

Survey type (character), e.g., "ech", "eaii".

default_engine

Default evaluation engine (character).

depends_on

Vector/list of dependencies declared by the steps.

user

Author/owner (character).

description

Recipe description (character).

id

Unique identifier (character/numeric).

steps

List of step calls that make up the workflow.

doi

DOI or external identifier (character|NULL).

bake

Logical flag indicating whether it has been applied.

topic

Recipe topic (character|NULL).

step_objects

List of Step R6 objects (list|NULL), used for documentation generation.

categories

List of RecipeCategory objects for classification.

downloads

Integer download/usage count.

certification

RecipeCertification object (default community).

user_info

RecipeUser object or NULL.

version

Recipe version string.

depends_on_recipes

List of recipe IDs that must be applied before this one.

data_source

List with S3 bucket info (s3_bucket, s3_prefix, file_pattern, provider) or NULL.

labels

List with variable and value labels (var_labels, val_labels) or NULL.

Methods

Public methods

• Recipe$new()

• Recipe$increment_downloads()

• Recipe$certify()

• Recipe$add_category()

• Recipe$remove_category()

• Recipe$to_list()

• Recipe$doc()

• Recipe$validate()

• Recipe$clone()

---

Recipe$new()

Create a Recipe object

Usage

Recipe$new(
  name,
  edition,
  survey_type,
  default_engine,
  depends_on,
  user,
  description,
  steps,
  id,
  doi = NULL,
  topic = NULL,
  step_objects = NULL,
  cached_doc = NULL,
  categories = list(),
  downloads = 0L,
  certification = NULL,
  user_info = NULL,
  version = "1.0.0",
  depends_on_recipes = list(),
  data_source = NULL,
  labels = NULL
)

Arguments

name

Descriptive name of the recipe (character)

edition

Target edition/period (character or Date)

survey_type

Survey type (character), e.g., "ech", "eaii"

default_engine

Default evaluation engine (character)

depends_on

Vector or list of declared dependencies

user

Author or owner of the recipe (character)

description

Detailed description of the recipe (character)

steps

List of step calls that make up the workflow

id

Unique identifier (character or numeric)

doi

DOI or external identifier (character or NULL)

topic

Recipe topic (character or NULL)

step_objects

List of Step R6 objects (optional, used for doc generation)

cached_doc

Pre-computed documentation (optional, used when loading from JSON)

categories

List of RecipeCategory objects (optional)

downloads

Integer download count (default 0)

certification

RecipeCertification object (optional, default community)

user_info

RecipeUser object (optional)

version

Recipe version string (default "1.0.0")

depends_on_recipes

List of recipe IDs that must be applied before this one (optional)

data_source

List with S3 bucket info (optional)

labels

List with var_labels and val_labels (optional)

---

Recipe$increment_downloads()

Increment the download counter

Usage

Recipe$increment_downloads()

---

Recipe$certify()

Certify the recipe at a given level

Usage

Recipe$certify(user, level)

Arguments

user

RecipeUser who is certifying

level

Character certification level ("reviewed" or "official")

---

Recipe$add_category()

Add a category to the recipe

Usage

Recipe$add_category(category)

Arguments

category

RecipeCategory to add

---

Recipe$remove_category()

Remove a category by name

Usage

Recipe$remove_category(name)

Arguments

name

Character category name to remove

---

Recipe$to_list()

Serialize Recipe to a plain list suitable for JSON/API publishing. Steps are encoded as character strings via deparse().

Usage

Recipe$to_list()

Returns

A named list with all recipe fields.

---

Recipe$doc()

Auto-generate documentation from recipe steps

Usage

Recipe$doc()

Returns

A list with metadata, input_variables, output_variables, and pipeline information

---

Recipe$validate()

Validate that a survey has all required input variables

Usage

Recipe$validate(svy)

Arguments

svy

A Survey object

Returns

TRUE if valid, otherwise stops with error listing missing variables

---

Recipe$clone()

The objects of this class are cloneable with this method.

Usage

Recipe$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

# Use the recipe() constructor:
svy <- survey_empty(type = "ech", edition = "2023")
r <- recipe(
  name = "Example", user = "Test", svy = svy,
  description = "Example recipe"
)