Learn R Programming

crunch (version 1.31.1)

Crunch.io Data Tools

Description

The Crunch.io service provides a cloud-based data store and analytic engine, as well as an intuitive web interface. Using this package, analysts can interact with and manipulate Crunch datasets from within R. Importantly, this allows technical researchers to collaborate naturally with team members, managers, and clients who prefer a point-and-click interface.

Copy Link

Version

Install

install.packages('crunch')

Monthly Downloads

570

Version

1.31.1

License

LGPL (>= 3)

Issues

Pull Requests

Stars

Forks

Maintainer

Greg Freedman Ellis

Last Published

August 19th, 2025

Functions in crunch (1.31.1)

CrunchVariable-class

Variables in Crunch
ContextManager

Context managers
DatasetOrder-class

Organize Datasets
CrunchDataFrame

CrunchDataFrame
CrunchDataset-class

Crunch Datasets
Insertions-class

Insert categories in transformations
Categories-class

Categories in CategoricalVariables
SO_schema

Schema for the 2017 Stack Overflow developer survey
AbstractCategories-class

Abstract categories
SO_survey

R users who responded to the 2017 Stack Overflow developer survey
ShojiObject-class

Mix-in class for multiple inheritance of variables and datasets.
Subvariables-class

Subvariables in Array Variables
VariableCatalog-class

Collection of Variables within a Dataset
VariableOrder-class

Organize Variables within a Dataset
Transforms-class

Transformations of variable and cube views
SummaryStat-class

Summary insertions
addGeoMetadata

Add geodata metadata to a crunch variable
VariableDefinition

Construct a variable definition
ShojiOrder-slots

Manipulate VariableGroup and VariableOrder
Subtotal-class

Subtotals and headings
addSubvariable

Add subvariable to an array
addVariables

Add multiple variables to a dataset
archive-and-publish

Get and set "archived" and "published" status of a dataset
as-vector

Convert Variables to local R objects
subtotalArray

Calculate the transforms from a CrunchCube
filter

Get and set slide analyses
appendDataset

Append one Crunch dataset to another
applyAgainst

apply a function against a dimension
appendStream

Manually trigger a pending append to a dataset
catalog-dataframes

as.data.frame method for catalog objects
catalogToDataFrame

A utility to return a data.frame from a ShojiCatalog.
batches

See the appended batches of this dataset
addSummaryStat

Add summary statistics to a CrunchCube
categoriesFromLevels

Convert a factor's levels into Crunch categories.
availableGeodataFeatures

Get the property features for available geographies
calcTransforms

Given a vector of values and elements, calculate the insertions
automation-undo

Undo behavior of a Crunch Automation Script
as.environment,CrunchDataset-method

as.environment method for CrunchDataset
c-categories

S3 method to concatenate Categories and Category objects
buildDelimRegex

Build Regex to find delimited items.
cleanseBatches

Remove batches from a dataset
compareDatasets

Compare two datasets to see how they will append
conditionalTransform

Conditional transformation
combine

Combine categories or responses
check_margins

Check validity of margins
collapseCategories

Combine Categories in place
cd

Change to different folder
changeCategoryID

Change the id of a category for a categorical variable
collapse_dims

Collapse an array from a CrunchCube by summing
checkInstalledPackages

Check if a user has packages installed
createWithPreparedData

Upload a prepared data.frame with metadata to Crunch
crunch-api-key

Crunch API Keys
copyVariable

Copy a variable
createWithMetadataAndFile

Make a dataset with metadata and a CSV
copyOrder

Copy the variable order from one dataset to another.
copyFolders

Copy the folder structure from one dataset to another.
crtabs

Crunch xtabs: Crosstab and otherwise aggregate variables in a Crunch Dataset
consent

Give consent to do things that require permission
createDataset

Create an empty dataset
createSubvarDeriv

Create subvariable derivation expressions
crunch_user_agent

Generate or extend the User-Agent string
crunch_sitrep

Crunch situation report
crunch-uni

Univariate statistics on Crunch objects
crunchBox

Make a CrunchBox
is.VariableDefinition

Test whether a Crunch object belongs to a class
cube-computing

Work with CrunchCubes, MultitableResults, and TabBookResults
crunch-package

crunch: Crunch.io Data Tools
crunch-summary

Summary methods for Crunch Variables
crunchAPI

Main Crunch API handling function
crunch-extract

Extract and modify Crunch objects
owner

Get and set the owner of a dataset
dataset-to-R

as.data.frame method for CrunchDataset
dimensions

Methods on Cube objects
cut,DatetimeVariable-method

Cut a Datetime Crunch variable
cube-residuals

Calculate standardized residuals from a CrunchCube
showMissing

Modify cube missing behavior
cut,NumericVariable-method

Cut a numeric Crunch variable
dashboard

View or set a dashboard URL
datasetReference

Get a Crunch object's dataset URL
cubeMeasureType

Get measure type of cube result
deleteDataset

Delete a dataset from the dataset list
deriveArray

Make a Categorical Array or Multiple Response variable
delete

Delete a Crunch object from the server
deleteVariables

Delete Variables Within a Dataset
datasets

Get a catalog of datasets
deleteSubvariables

Delete subvariables from an array
titles

Manipulate deck titles
decks

Get a dataset's DeckCatalog
derivation

Get or set a derived variable's expression
aliases

Get and set names, aliases on Catalog-type objects
embedCrunchBox

Get HTML for embedding a CrunchBox
dimension-comparison-pairwise

Pairwise column and row comparison
ensureValidCase

Validate case statements for case variables
dimSums

Collapse an array from a CrunchCube by summing across dimensions to remove
duplicated

"duplicated" method for Crunch objects
describe-entity

Name, alias, and description for Crunch objects
ncol

Dataset dimensions
dropRows

Permanently delete rows from a dataset
dichotomize

Indicate how categories represent a dichotomized value
dimension-comparison

Column and row comparison
exclusion

View and set exclusion filters
expressions-internal

Crunch expressions internal
expressions

Construct Crunch Expressions from Crunch Database Functions
exportDataset

Export a dataset to a file
exportDeck

Export a Crunch Deck
filters

Get or set a dataset's filters
flattenOrder

Remove nesting of groups within an order/group
envOrOption

Get/set options (user-specified, in environment, or in R options)
fillExpr

Expression to fill a variable from another
escapeRegex

Escape a regular expression
forceVariableCatalog

Force variables catalog to be loaded
flipArrays

Rearrange array subvariables
generateWeightEntry

Generate entry for makeWeight
getDimTypes

Get dimension type
folder

Find and move entities to a new folder
fortify

Fortify crunch objects for use with ggplot
generateNumCutLabels

Generate Labels for the cut function
CrunchGeography-class

Geography properties for crunch variables
getAccountUserCatalog

Find all users on your account
forkDataset

Create a fork of a dataset
grouped

Get grouped or ungrouped OrderGroups
interactVariables

Create a variable by interacting categorical variables
index.table

Calculate an index table for a CrunchCube
http-methods

HTTP methods for communicating with the Crunch API
publicFolder

Hide/Unhide or Privatize/Deprivatize Variables
getTeams

Retrieve your teams
hasFunction

Check if a package has a function installed
handleAPIresponse

Do the right thing with the HTTP response
grabColNames

grab column names for subsetting crdfs
grabRowInd

grab row indicators for subsetting crdfs
is-na-categories

is.na for Categories
lock

Lock and unlock a dataset for editing
loadDataset

Load a Crunch Dataset
length

Length of Crunch objects
is.editor

Read and set edit privileges
is.TRUEorFALSE

Check that a value is TRUE or FALSE
listDatasets

Get the names of datasets in a project
joinDatasets

Add columns from one dataset to another, joining on a key
logout

DEPRECATED! Authenticate with the Crunch API
is-public

View and modify the "public" attribute of artifacts
makeCaseVariable

Make a case variable
margin-translation

Convert from user margins to real cube margins or vice versa
makeWeight

Generate a weight variable
me

My user entity
matchCatToFeat

Match categories with features from geodata
makeDimTransform

Helper for creating slide dimension transformations for dashboards and exports
makeCaseWhenVariable

Create a categorical or numeric variable based on conditions
makeMRFromText

Create Multiple Response Variable from Delimited lists
makeMarginMap

Make a map of margins
makeInsertion

Convert a child class of Insertion into a proper Insertion
moveLastElement

Move and delete last element of a vector This moves the last element of a vector to an index, then deletes the last element, it is broken out for testing purposes
na.omit

Omit missing categories
mergeFork

Merge changes to a dataset from a fork
mv

Functions to manipulate variables' or project's folder structure
merge

Merge a CrunchDataFrame
weightVariables<-

Change which variables can be set as a dataset's weight.
members

Manage access to datasets and other objects
newDatasetByColumn

Upload a data.frame column-by-column to make a new dataset
multitables

Multitable entities for a dataset
newDataset

Upload data to Crunch to make a new dataset
newProject

Create a new folder
newExampleDataset

Import a fixture dataset for testing
newSlide

Append a new slide to a Crunch Deck
newDeck

Create an empty Crunch Deck
newFilter

Create a new filter
slideMarkdown

Add a new markdown slide to a deck
newDatasetFromFile

Upload a file to Crunch to make a new dataset
noTransforms

Remove transformations from a CrunchCube
newMultitable

Create a new Multitable
notifyIfNewVersion

See if there's a new version of the package on GitHub
pk

Get and set the primary key for a Crunch dataset
palettes

Get the palettes from a crunch object
popSize

Get and set the market size for Crunch datasets
pollProgress

Check a Crunch progress URL until it finishes
prepareDataForCrunch

Translate a data.frame to Crunch format
ordering

Get and set VariableOrder
projects

List project folders
owners

See who owns these datasets
pendingStream

Get the pending streams for a dataset
preCrunchBoxCheck

Check if a dataset will make a good CrunchBox
reorderSlides

Reorder slides in a CrunchDeck
restoreVersion

Restore a dataset to a previously saved version
removeEmptyGroups

Remove OrderGroups with no entities
retry

Retry
rmdir

Delete a folder
refresh

Get a fresh copy from the server
resolution

Methods for Datetime variable resolutions
reassignUser

Reassign all Crunch objects from a user
rowCount

Create variables based on row-wise functions for crunch Multiple Response Variables
scoreCatToFeat

Score similarity between a feature dataframe and categories
scripts

Crunch Automation scripts entities for a dataset
self

Get the URL of this object
serialPaste

Make a prose list
saveVersion

Create a new saved version
rowDistinct

Create variables useful for determining whether a row's values are suspicious
replaceCharWithNumeric

Transform character vectors into indices
session-extract

Extract catalogs from a Session object
replaceMissingWithTRUE

Replace missing elements with TRUE
runCrunchAutomation

Run a crunch automation script
searchDatasets

Search Crunch for datasets.
setOrder

Change the order of entities in folder
session

Get various catalogs for your Crunch session
setMultiEntitySlots

setter for Crunch objects that allows a single request to update multiple parts of an entity
setName

Change the name of the current folder
setEntitySlotWrapBody

Setter for Crunch objects that wraps in a "body"
setEntitySlot

Base setter for Crunch objects
showTransforms

Show transformations on a Crunch object
index

Get the body of a Catalog
setNames

Change the name of the entities in a catalog
share

Share a dataset
settings

View and modify dataset-level settings
set_crunch_config

Set or modify general Crunch API request configuration
show

Show methods for Crunch objects
slides

Access the slides of a CrunchDeck
slideCategories

Create sliding subvariable definitions
setupCrunchAuth

Helper for switching between API keys and urls
skipMissingCategories

Handle missing categories in CrunchCube
shojifyDatasetMetadata

Wrap variable metadata inside a dataset entity
shojiURL

Get a resource URL from a Shoji Object
setCrunchAPI

Change which server to point to
tabBook

Compute a Tab Book
subtypeInsertion

Convert from Insertion to Insertion subtypes
streaming

Set the streaming property of a dataset
table

Table function for Crunch objects
team

Share Crunch assets with a team
tabbook-dim

TabBookResult and MultitableResult dimension
temp.options

Set some global options temporarily
tojson-crunch

toJSON methods for Crunch objects
toVariable

Generic method for converting objects to Crunch representations
streamRows

Stream data to a Crunch dataset
users

Get information about users who have access to a dataset
unbind

Split an array or multiple-response variable into its CategoricalVariables
translateHidden

Translate provided index to an index which accounts for hidden categories.
email

Extract the email from a User Entity
type

Change Crunch variable types
unshare

Revoke a user's access to a dataset
urls,ShojiCatalog-method

Get the URLs contained in a Catalog or Order object
entity

Methods for ShojiTuples
translateCubeIndex

Translate user facing cube subset to programmatic cube subset
tokenAuth

Add an auth token manually
variables

Access a catalog of variables
validateNamesInDims

error iff the names are not a dimension in the cube provided
variableMetadata

Get all variable metadata for a dataset
versions

Access the saved versions of a dataset
as.Text

as.* methods for variables
var-categories

Get and set Categories on Variables
which

"which" method for CrunchLogicalExpr
webApp

View a Crunch Object in the Web Application
is.weight<-

Dataset weights
weightVariables

Get a dataset's weightVariables
with-context-manager

Context manager's "with" method
write.csv.gz

Write CSV to a compressed file
writePreparedData

Persist to disk a prepared data.frame and metadata