makeInsertion: Convert a child class of Insertion into a proper Insertion

In crunch: Crunch.io Data Tools

Convert a child class of Insertion into a proper Insertion

Description

The Crunch API expects that Subtotals, Headings, and other insertions all have the same shape. Before sending insertions to the server, we need to call makeInsertion on any insertions to make sure they are proper Insertions. This process sometimes requires a variable's categories object (e.g. in order to convert from category names to category ids)

The Crunch API expects that Subtotals, Headings, and other insertions all have the same shape. Before sending insertions to the server, we need to call makeInsertion on any insertions to make sure they are proper Insertions. This process sometimes requires a variable's categories object (e.g. in order to convert from category names to category ids)

Usage

## S4 method for signature 'Subtotal'
makeInsertion(x, var_items, alias)

## S4 method for signature 'Heading'
makeInsertion(x, var_items, alias)

## S4 method for signature 'Insertion'
makeInsertion(x, var_items, alias)

## S4 method for signature 'Subtotal'
makeInsertion(x, var_items, alias)

## S4 method for signature 'Heading'
makeInsertion(x, var_items, alias)

## S4 method for signature 'Insertion'
makeInsertion(x, var_items, alias)

## S4 method for signature 'SummaryStat'
makeInsertion(x, var_items, alias)

Arguments

x	an object the is a child of Insertion (e.g. Subtotal, Heading)
var_items	Either categories (from categories(variable)) or subvariables (from subvariables(variable)) to used by makeInsertions to make Insertions from a child object (e.g. Subtotal or Heading).
alias	The alias of the variable the insertion is being added to, only needed for MR insertions.

Value

an Insertion object

an Insertion object

crunch documentation built on May 29, 2024, 5:03 a.m.