Function reference • Crunch

Upload
`newDataset()`	Upload data to Crunch to make a new dataset
`toVariable()`	Generic method for converting objects to Crunch representations
`VariableDefinition()` `VarDef()`	Construct a variable definition
`addVariables()`	Add multiple variables to a dataset
`appendStream()`	Manually trigger a pending append to a dataset
`pendingStream()`	Get the pending streams for a dataset
`pk` `pk<-`	Get and set the primary key for a Crunch dataset
`prepareDataForCrunch()`	Translate a data.frame to Crunch format
`createWithPreparedData()`	Upload a prepared data.frame with metadata to Crunch
Load
`listDatasets()`	Show the names of all Crunch datasets associated with a catalog
`loadDataset()`	Load a Crunch Dataset
`datasets()` `datasets<-`()	Get the dataset catalog
Dataset manipulation
`as.environment`	as.environment method for CrunchDataset
`batches()`	See the appended batches of this dataset
`cleanseBatches()`	Remove batches from a dataset
`as.data.frame`	as.data.frame method for CrunchDataset
`delete`	Delete a Crunch object from the server
`deleteDataset()`	Delete a dataset from the dataset list
`dim` `ncol`	Dataset dimensions
`dropRows()`	Permanently delete rows from a dataset
`exclusion()` `exclusion<-`()	View and set exclusion filters
`restoreVersion()`	Restore a dataset to a previously saved version
`saveVersion()`	Create a new saved version
`versions()`	Access the saved versions of a dataset
`weight()` `weight<-`() `is.weight()` `is.weight<-`	Dataset weights
`weightVariables`	Get a dataset's weightVariables
`modifyWeightVariables()` `weightVariables<-` `is.weightVariable()` `is.weightVariable<-`	Change which variables can be set as a dataset's weight.
`settings()` `settings<-`()	View and modify dataset-level settings
`popSize` `popSize<-` `popMagnitude` `popMagnitude<-` `setPopulation`	Get and set the market size for Crunch datasets
`lock()` `unlock()`	Lock and unlock a dataset for editing
Multiple datasets
`appendDataset()`	Append one Crunch dataset to another
`compareDatasets()`	Compare two datasets to see how they will append
`joinDatasets()` `extendDataset()` `merge`	Add columns from one dataset to another, joining on a key
`forkDataset()`	Create a fork of a dataset
`mergeFork()`	Merge changes to a dataset from a fork
`searchDatasets()`	Search Crunch for datasets.
Variable manipulation
`c`	S3 method to concatenate Categories and Category objects
`categoriesFromLevels()`	Convert a factor's levels into Crunch categories.
`changeCategoryID()`	Change the id of a category for a categorical variable
`collapseCategories()`	Combine Categories in place
`variables` `variables<-` `allVariables` `allVariables<-`	Access a Dataset's Variables Catalog
`deleteVariables()` `deleteVariable()`	Delete Variables Within a Dataset
`derivation` `derivation<-` `is.derived` `is.derived<-`	Get or set a derived variable's expression
`name` `name<-` `id` `value` `value<-` `is.selected`	Category attributes
`is.dichotomized` `dichotomize` `undichotomize`	Indicate how categories represent a dichotomized value
`hiddenVariables()`	Show the names of a dataset's hidden variables
`hide` `unhide`	Hide and Unhide Variables
`hideVariables()` `hiddenVariables<-`() `unhideVariables()`	Hide and unhide variables within a dataset
`na.omit`	Omit missing categories
`type` `type<-`	Change Crunch variable types
`categories` `categories<-`	Get and set Categories on Variables
`variableMetadata()`	Get all variable metadata for a dataset
Deriving variables
`combine()`	Combine categories or responses
`copyVariable()` `copy()`	Copy a variable
`makeCaseVariable()`	Make a case variable
`cut`	Cut a numeric Crunch variable
`interactVariables()`	Create a variable by interacting categorical variables
`conditionalTransform()`	Conditional transformation
`makeWeight()`	Generate a weight variable
`as.Numeric` `as.Text` `as.Categorical` `as.Datetime` `as.double` `as.character`	as.* methods for variables
Array variables
`subvariables` `subvariables<-`	Subvariables in Array Variables
`addSubvariable()` `addSubvariables()`	Add subvariable to an array
`deleteSubvariables()` `deleteSubvariable()`	Delete subvariables from an array
`flipArrays()`	Rearrange array subvariables
`importMultitable()`	Import a Multitable
`makeArray()` `makeMR()` `deriveArray()`	Make a Categorical Array or Multiple Response variable
`makeMRFromText()`	Create Multiple Response Variable from Delimited lists
`is.selected` `is.selected<-`	is.selected for Categories
`unbind()`	Split an array or multiple-response variable into its CategoricalVariables
Ordering
`ordering` `ordering<-`	Get and set VariableOrder
`length`	Length of an Order
`entities` `entities<-` `name` `name<-` `names` `names<-` `duplicates` `duplicates<-`	Manipulate VariableGroup and VariableOrder
`copyOrder()`	Copy the variable order from one dataset to another.
`dedupeOrder()`	Remove duplicated entities from an order/group
`flattenOrder()`	Remove nesting of groups within an order/group
`grouped()` `ungrouped()`	Get grouped or ungrouped OrderGroups
`locateEntity()`	Find an entity in an order object
`moveToGroup()` `moveToGroup<-`()	Move entities to a group
`removeEmptyGroups()`	Remove OrderGroups with no entities
`folder()` `folder<-`()	Find and move variables to a new folder
`mv()` `mkdir()`	Functions to manipulate variables' folder structure
`cd()`	Change to different folder
`rmdir()`	Delete a folder
`setOrder()`	Change the order of entities in folder
Analysis
`crtabs()`	Crunch xtabs: Crosstab and otherwise aggregate variables in a Crunch Dataset
`mean` `sd` `min` `max`	Univariate statistics on Crunch objects
`margin.table` `prop.table` `round` `bases`	Work with CrunchCubes, MultitableResults, and TabBookResults
`dimnames` `dim` `is.na` `dimensions` `dimensions<-` `[` `variables` `measures` `names` `aliases` `descriptions` `types` `notes`	Methods on Cube objects
`rstandard`	Calculate standardized residuals from a CrunchCube
`index.table()`	Calculate an index table for a CrunchCube
`dashboard()` `setDashboardURL()` `dashboard<-`()	View or set a dashboard URL
`duplicated`	"duplicated" method for Crunch objects
`filters` `filters<-`	Get or set a dataset's filters
`fortify.CrunchDataFrame()` `fortify.CrunchDataset()`	Fortify crunch objects for use with ggplot
`is.na` `is.na<-`	is.na for Categories
`multitables` `multitables<-`	Multitable entities for a dataset
`newFilter()`	Create a new filter
`newMultitable()`	Create a new Multitable
`table()`	Table function for Crunch objects
`as.vector`	Convert Variables to local R objects
Data presentation
`Subtotal()` `Heading()` `is.Subtotal()` `is.Heading()` `are.Subtotals()` `are.Headings()` `subtotals` `subtotals<-`	Subtotals and headings
`subtotalArray` `applyTransforms()`	Calculate the transforms from a CrunchCube
`noTransforms()`	Remove transformations from a CrunchCube
`showTransforms`	Show transformations on a Crunch object
`Insertions()` `Insertion()` `.Insertion()` `anchor<-` `subtotals<-` `arguments<-` `arguments` `anchor` `func` `anchors` `funcs`	Insert categories in transformations
`Transforms()` `transforms` `transforms<-`	Transformations of variable and cube views
Export
`crunchBox()` `CrunchBox()`	Make a CrunchBox
`embedCrunchBox()`	Get HTML for embedding a CrunchBox
`exportDataset()` `write.csv`	Export a dataset to a file
`preCrunchBoxCheck()`	Check if a dataset will make a good CrunchBox
`tabBook()`	Compute a Tab Book
`write.csv.gz()`	Write CSV to a compressed file
`writePreparedData()`	Persist to disk a prepared data.frame and metadata
`pollProgress()`	Check a Crunch progress URL until it finishes
`dim` `names` `[` `[<-` `[[` `[[<-` `$` `$<-`	CrunchDataFrame
`merge`	Merge a CrunchDataFrame
Geodata
`addGeoMetadata()`	Add geodata metadata to a crunch variable
`availableGeodataFeatures()`	Get the property features for available geographies
`CrunchGeography()` `geo` `geo<-` `availableGeodata()`	Geography properties for crunch variables
`matchCatToFeat()`	Match categories with features from geodata
`scoreCatToFeat()`	Score similarity between a feature dataframe and categories
Admin
`is.archived` `is.draft` `is.published` `is.archived<-` `is.draft<-` `is.published<-` `archive()` `publish()`	Get and set "archived" and "published" status of a dataset
`owner` `owner<-`	Get and set the owner of a dataset
`getAccountUserCatalog()`	Find all users on your account
`getTeams()`	Retrieve your teams
`is.public` `is.public<-`	View and modify "public" attribute
`is.editor` `is.editor<-`	Read and set edit privileges
`login()`	Authenticate with the Crunch API
`logout()`	Kill the active Crunch session
`me()`	My user entity
`newProject()`	Create a new project
`owners()` `ownerNames()`	See who owns these datasets
`permissions`	See who has access to a dataset
`icon()` `icon<-`()	Get or set a project's icon
`projects()`	Get the project catalog
`resetPassword()`	Reset your password
`share()`	Share a dataset
`members<-` `members`	Teams
`unshare()`	Revoke a user's access to a dataset
`expropriateUser()`	Expropriate all Crunch objects from a user
Catalogs
`length`	Length of Catalog
`as.data.frame`	as.data.frame method for catalog objects
`names` `names<-` `emails` `types` `aliases` `aliases<-` `notes` `notes<-` `descriptions` `descriptions<-` `ids` `timestamps`	Get and set names, aliases on Catalog-type objects
`index` `index<-`	Get the body of a Catalog
Crunch options
`consent()` `with_consent()`	Give consent to do things that require permission
Utility
`is.dataset()` `is.CrunchExpr()` `is.Expr()` `is.Geodata()` `is.shoji()` `is.variable()` `is.Numeric()` `is.Categorical()` `is.Text()` `is.Datetime()` `is.Multiple()` `is.MR()` `is.MultipleResponse()` `is.CA()` `is.Array()` `is.CategoricalArray()`	Test whether a Crunch object belongs to a class
`name` `name<-` `description` `description<-` `startDate` `startDate<-` `endDate` `endDate<-` `id` `notes` `notes<-` `alias` `alias<-` `digits` `digits<-` `uniformBasis` `uniformBasis<-`	Name, alias, and description for Crunch objects
`refresh`	Get a fresh copy from the server
`webApp()`	View a Crunch Object in the Web Application
API
`crGET()` `crPUT()` `crPATCH()` `crPOST()` `crDELETE()`	HTTP methods for communicating with the Crunch API
`self`	Get the URL of this object
`session()`	Get various catalogs for your Crunch session
`jsonprep()` `toJSON()`	toJSON methods for Crunch objects
Other
`Categories()` `Category()` `[` `[<-` `[[` `[[<-` `names` `names<-` `ids` `ids<-` `values` `values<-`	Categories in CategoricalVariables
`CrunchDataset-class`	Crunch Datasets
`CrunchVariable-class`	Variables in Crunch
`DatasetOrder-class`	Organize Datasets
`ShojiObject-class`	Mix-in class for multiple inheritance of variables and datasets.
`[` `[[` `$` `[<-` `[[<-` `$<-`	Extract and update in VariableOrders and VariableGroups
`VariableCatalog-class`	Collection of Variables within a Dataset
`VariableOrder-class`	Organize Variables within a Dataset
`[[` `[[<-` `[` `$` `$<-` `[<-`	Extract and modify subsets of Catalog-type objects
`$` `$<-`	Access Category fields directly
`crunch`	Crunch.io: instant, visual, collaborative data analysis
`[` `subset` `[[` `$`	Subset datasets and extract variables
`[[<-` `$<-` `[<-`	Update a variable or variables in a dataset
`!` `%in%` `==` `!=` `is.na` `bin()` `rollup()` `rollupResolution()` `rollupResolution<-`	Construct Crunch Expressions
`[[` `$` `[[<-` `$<-`	Extract catalogs from a Session object
`[[` `[` `[[<-` `[<-` `$` `$<-`	Extract and modify subsets of subvariables
`length` `[[` `dim` `names` `aliases` `descriptions`	TabBookResult and MultitableResult methods
`entity` `$` `$<-` `[[` `[[<-` `refresh` `self` `delete` `name` `name<-` `type`	Methods for ShojiTuples
`[`	"Subset" a Variable
`[<-` `is.na<-`	Update variables with expressions or values
Internal
`ContextManager()`	Context managers
`show`	Show methods for Crunch objects
`temp.options()` `temp.option()`	Set some global options temporarily
`which`	"which" method for CrunchLogicalExpr
`with`	Context manager's "with" method

Reference

Upload

Load

Dataset manipulation

Multiple datasets

Variable manipulation

Deriving variables

Array variables

Ordering

Analysis

Data presentation

Export

Geodata

Admin

Catalogs

Crunch options

Utility

API

Other

Internal

Contents