Function reference • Crunch

Upload
`newDataset()`	Upload data to Crunch to make a new dataset
`newExampleDataset()`	Import a fixture dataset for testing
`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()`	Get the names of datasets in a project
`loadDataset()`	Load a Crunch Dataset
`datasets()` `datasets<-`()	Get a catalog of datasets
Dataset manipulation
`as.environment(<CrunchDataset>)`	as.environment method for CrunchDataset
`batches()`	See the appended batches of this dataset
`cleanseBatches()`	Remove batches from a dataset
`as.data.frame(<CrunchDataset>)` `as.data.frame(<CrunchDataFrame>)`	as.data.frame method for CrunchDataset
`delete()`	Delete a Crunch object from the server
`deleteDataset()`	Delete a dataset from the dataset list
`ncol()` `dim(<CrunchDataset>)`	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
`is.weight<-` `weight` `weight<-` `weight<-,Analysis,CrunchVariable-method` `weight<-,Analysis,NULL-method` `weight,CrunchDataset-method` `weight<-,CrunchDataset,ANY-method` `is.weight` `is.weight<-,NumericVariable-method`	Dataset weights
`weightVariables()`	Get a dataset's weightVariables
`weightVariables<-`() `is.weightVariable<-`() `modifyWeightVariables()` `is.weightVariable()`	Change which variables can be set as a dataset's weight.
`settings()` `settings<-`()	View and modify dataset-level settings
`popSize()` `popMagnitude()` `popSize<-`() `popMagnitude<-`() `setPopulation()`	Get and set the market size for Crunch datasets
`lock()` `unlock()`	Lock and unlock a dataset for editing
`streaming()` `streaming<-`()	Set the streaming property of a dataset
`palettes()` `defaultPalette()`	Get the palettes from a crunch object
Multiple datasets
`appendDataset()`	Append one Crunch dataset to another
`compareDatasets()`	Compare two datasets to see how they will append
`joinDatasets()` `extendDataset()` `merge(<CrunchDataset>)`	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(<Categories>)` `c(<Category>)`	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 catalog of variables
`deleteVariables()` `deleteVariable()`	Delete Variables Within a Dataset
`derivation` `derivation<-` `is.derived` `is.derived<-` `derivations` `derivation,CrunchVariable-method` `derivation<-,CrunchVariable,ANY-method` `derivation<-,CrunchVariable,NULL-method` `is.derived,CrunchVariable-method` `is.derived<-,CrunchVariable,logical-method`	Get or set a derived variable's expression
`publicFolder()` `hiddenFolder()` `privateFolder()` `hide()` `unhide()` `privatize()` `deprivatize()` `hideVariables()` `hiddenVariables<-`() `unhideVariables()` `hiddenVariables()` `privatise()` `deprivatise()` `privatizeVariables()` `privatiseVariables()` `privateVariables<-`() `deprivatizeVariables()` `deprivatiseVariables()` `privateVariables()`	Hide/Unhide or Privatize/Deprivatize Variables
`na.omit()`	Omit missing categories
`resolution()` `resolution<-`() `rollup()` `rollupResolution()` `rollupResolution<-`()	Methods for Datetime variable resolutions
`type()` `type<-`()	Change Crunch variable types
`categories()` `categories<-`()	Get and set Categories on Variables
`Categories()` `Category()`	Categories in CategoricalVariables
`variableMetadata()`	Get all variable metadata for a dataset
Deriving variables
`crunchdbFunc()`	Construct Crunch Expressions from Crunch Database Functions
`combine()` `combineCategories()` `combineResponses()`	Combine categories or responses
`copyVariable()` `copy()`	Copy a variable
`makeCaseVariable()` `caseExpr()`	Make a case variable
`makeCaseWhenVariable()` `caseWhenExpr()`	Create a categorical or numeric variable based on conditions
`cut(<NumericVariable>)`	Cut a numeric Crunch variable
`cut(<DatetimeVariable>)`	Cut a Datetime Crunch variable
`interactVariables()`	Create a variable by interacting categorical variables
`conditionalTransform()`	Conditional transformation
`makeWeight()`	Generate a weight variable
`as.Text()` `as.Numeric()` `as.Categorical()` `as.Datetime()` `as.double(<CrunchVariable>)` `as.character(<CrunchVariable>)` `as.double(<CrunchExpr>)` `as.character(<CrunchExpr>)`	as.* methods for variables
`which(<CrunchLogicalExpr>)`	"which" method for CrunchLogicalExpr
`rowCount()`	Create variables based on row-wise functions for crunch Multiple Response Variables
`rowDistinct()` `straightlineResponse()`	Create variables useful for determining whether a row's values are suspicious
`slideCategories()`	Create sliding subvariable definitions
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
`deriveArray()` `makeArray()` `makeMR()`	Make a Categorical Array or Multiple Response variable
`makeMRFromText()`	Create Multiple Response Variable from Delimited lists
`makeArrayGadget()`	Array builder
`is.dichotomized()` `dichotomize()` `undichotomize()` `is.selected()` `is.selected<-`()	Indicate how categories represent a dichotomized value
`unbind()`	Split an array or multiple-response variable into its CategoricalVariables
Folders and organization
`folder()` `folder<-`()	Find and move entities to a new folder
`mv()` `mkdir()`	Functions to manipulate variables' or project's folder structure
`cd()`	Change to different folder
`rmdir()`	Delete a folder
`setOrder()`	Change the order of entities in folder
`setName()`	Change the name of the current folder
`setNames()`	Change the name of the entities in a catalog
`copyFolders()`	Copy the folder structure from one dataset to another.
`copyOrder()`	Copy the variable order from one dataset to another.
Crunch Automation
`runCrunchAutomation()` `showScriptErrors()`	Run a crunch automation script
`undoScript()` `revertScript()` `scriptSavepoint()`	Undo behavior of a Crunch Automation Script
`scripts()`	Crunch Automation scripts entities for a dataset
Analysis
`crtabs()`	Crunch xtabs: Crosstab and otherwise aggregate variables in a Crunch Dataset
`mean()` `sd()` `median()` `min(<CrunchVariable>)` `min(<NumericVariable>)` `min(<DatetimeVariable>)` `max(<CrunchVariable>)` `max(<NumericVariable>)` `max(<DatetimeVariable>)`	Univariate statistics on Crunch objects
`margin.table()` `prop.table()` `bases()` `round(<CrunchCube>)`	Work with CrunchCubes, MultitableResults, and TabBookResults
`dimensions()` `dimensions<-`() `measures()` `dimnames(<CubeDims>)` `dim(<CubeDims>)` `is.na(<CubeDims>)` `dim(<CrunchCube>)` `dimnames(<CrunchCube>)`	Methods on Cube objects
`zScores()` `rstandard()`	Calculate standardized residuals from a CrunchCube
`showMissing()` `hideMissing()` `showIfAny()`	Modify cube missing behavior
`cubeMeasureType()`	Get measure type of cube result
`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
`is.na(<Categories>)` `is.na<-`(<Categories>,<character>) `is.na<-`(<Categories>,<logical>) `is.na(<Category>)` `is.na<-`(<Category>,<logical>)	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(<CrunchVariable>)` `as.vector(<CrunchExpr>)`	Convert Variables to local R objects
`compareCols()` `compareRows()` `compareDims()`	Column and row comparison
`compareColsPairwise()` `compareRowsPairwise()` `compareDimsPairwise()`	Pairwise column and row comparison
Decks
`decks()` `decks<-`()	Get a dataset's DeckCatalog
`newDeck()`	Create an empty Crunch Deck
`filter` `filter<-` `weight<-,CrunchDeck,ANY-method` `filter<-,CrunchDeck-method` `filters<-,CrunchDeck,ANY-method` `transforms,CrunchAnalysisSlide-method` `transforms,AnalysisCatalog-method` `transforms,Analysis-method` `transforms<-,CrunchAnalysisSlide,ANY-method` `transforms<-,AnalysisCatalog,ANY-method` `transforms<-,Analysis,ANY-method` `analyses` `analysis` `analysis<-` `query<-` `cube` `cubes` `displaySettings` `displaySettings<-` `vizSpecs` `vizSpecs<-` `type,CrunchSlide-method` `analyses,CrunchAnalysisSlide-method` `analysis,CrunchAnalysisSlide-method` `analysis<-,CrunchAnalysisSlide,formula-method` `analysis<-,CrunchAnalysisSlide,Analysis-method` `analysis<-,CrunchAnalysisSlide,list-method` `filter,CrunchAnalysisSlide-method` `filters,CrunchAnalysisSlide-method` `filters<-,CrunchAnalysisSlide,ANY-method` `query<-,CrunchAnalysisSlide,ANY-method` `cubes,CrunchAnalysisSlide-method` `cube,CrunchAnalysisSlide-method` `displaySettings,CrunchAnalysisSlide-method` `displaySettings<-,CrunchAnalysisSlide,ANY-method` `vizSpecs,CrunchAnalysisSlide-method` `vizSpecs<-,CrunchAnalysisSlide,ANY-method` `cubes,AnalysisCatalog-method` `displaySettings,AnalysisCatalog-method` `displaySettings<-,AnalysisCatalog,list-method` `vizSpecs,AnalysisCatalog-method` `vizSpecs<-,AnalysisCatalog,list-method` `query<-,Analysis,formula-method` `formulaToSlideQuery` `cube,Analysis-method` `displaySettings,Analysis-method` `displaySettings<-,Analysis,ANY-method` `vizSpecs,Analysis-method` `vizSpecs<-,Analysis,ANY-method` `filter,Analysis-method` `filters,Analysis-method` `filter,ANY-method` `filter<-,CrunchAnalysisSlide-method` `filter<-,Analysis-method` `filters<-,Analysis,CrunchLogicalExpr-method` `filters<-,Analysis,CrunchFilter-method` `filters<-,Analysis,NULL-method` `filters<-,Analysis,list-method` `slideQueryEnv` `cubes,CrunchDeck-method` `weight,CrunchAnalysisSlide-method` `weight<-,CrunchAnalysisSlide,ANY-method` `weight,Analysis-method`	Get and set slide analyses
`slides()` `slides<-`()	Access the slides of a CrunchDeck
`newSlide()`	Append a new slide to a Crunch Deck
`makeDimTransform()`	Helper for creating slide dimension transformations for dashboards and exports
`slideMarkdown()` `slideMarkdown<-`() `newMarkdownSlide()` `markdownSlideImage()`	Add a new markdown slide to a deck
`titles()` `titles<-`() `title()` `title<-`() `subtitles()` `subtitles<-`() `subtitle()` `subtitle<-`()	Manipulate deck titles
`reorderSlides()`	Reorder slides in a CrunchDeck
`exportDeck()`	Export a Crunch Deck
Data presentation
`Subtotal-class` `Subtotal` `Heading-class` `Heading` `subtotals` `subtotals<-` `SubtotalsHeadings` `is.Subtotal` `is.Heading` `are.Subtotals` `are.Headings` `subtotals,CrunchVariable-method` `subtotals,VariableTuple-method` `subtotals<-,CrunchVariable,ANY-method` `subtotals<-,CrunchVariable,NULL-method`	Subtotals and headings
`subtotalArray()` `applyTransforms()`	Calculate the transforms from a CrunchCube
`noTransforms()`	Remove transformations from a CrunchCube
`showTransforms()`	Show transformations on a Crunch object
`addSummaryStat()`	Add summary statistics to a CrunchCube
`SummaryStat()` `SummaryStat()` `is.SummaryStat()` `are.SummaryStats()`	Summary insertions
`Insertions()` `Insertion()` `.Insertion()` `anchor()` `anchors()` `anchor<-`() `arguments()` `arguments<-`() `func()` `funcs()` `subtotals<-`(<Insertion>,<ANY>)	Insert categories in transformations
`Transforms-class` `Transforms` `TransformsList-class` `TransformsList` `transforms` `transforms<-` `transforms,CrunchVariable-method` `transforms,VariableTuple-method` `transforms<-,CrunchVariable,Transforms-method` `transforms<-,CrunchVariable,NULL-method` `transforms,CrunchCube-method` `transforms,VariableCatalog-method` `transforms<-,CrunchCube,ANY-method` `transforms<-,CrunchCube,TransformsList-method` `transforms<-,CrunchCube,NULL-method`	Transformations of variable and cube views
Export
`crunchBox()` `CrunchBox()`	Make a CrunchBox
`embedCrunchBox()`	Get HTML for embedding a CrunchBox
`exportDataset()` `write.csv(<CrunchDataset>)`	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(<CrunchDataFrame>)`	CrunchDataFrame
`merge(<CrunchDataFrame>)`	Merge a CrunchDataFrame
`dim(<TabBookResult>)`	TabBookResult and MultitableResult dimension
Geodata
`addGeoMetadata()`	Add geodata metadata to a crunch variable
`availableGeodataFeatures()`	Get the property features for available geographies
`CrunchGeography-class` `CrunchGeography` `Geodata-class` `Geodata` `geo` `geo<-` `geo,CrunchVariable-method` `geo<-,CrunchVariable,CrunchGeography-method` `geo<-,CrunchVariable,NULL-method` `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.archived<-`() `is.draft()` `is.draft<-`() `is.published()` `is.published<-`() `archive()` `publish()`	Get and set "archived" and "published" status of a dataset
`crunch-api-key`	Crunch API Keys
`crunch_sitrep()`	Crunch situation report
`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 the "public" attribute of artifacts
`is.editor()` `is.editor<-`()	Read and set edit privileges
`me()`	My user entity
`users()`	Get information about users who have access to a dataset
`email()`	Extract the email from a User Entity
`newProject()`	Create a new folder
`owners()` `ownerNames()`	See who owns these datasets
`members()` `members<-`() `permissions()`	Manage access to datasets and other objects
`projects()`	List project folders
`setupCrunchAuth()`	Helper for switching between API keys and urls
`share()`	Share a dataset
`unshare()`	Revoke a user's access to a dataset
`reassignUser()`	Reassign all Crunch objects from a user
`team()` `team<-`()	Share Crunch assets with a team
Utility
`is.VariableDefinition()` `is.VarDef()` `is.script()` `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.CategoricalArray()` `is.NumericArray()` `is.Array()`	Test whether a Crunch object belongs to a class
`describe-entity` `describe` `name` `name<-` `description` `description<-` `alias` `alias<-` `startDate` `startDate<-` `endDate` `endDate<-` `notes` `notes<-` `digits` `digits<-` `uniformBasis` `uniformBasis<-` `id` `value` `value<-` `name,AbstractCategory-method` `name<-,AbstractCategory-method` `name<-,NULL-method` `id,AbstractCategory-method` `value,Category-method` `value<-,Category-method` `dates,Category-method` `dates<-,Category-method` `name,CrunchDataset-method` `name<-,CrunchDataset-method` `description,CrunchDataset-method` `description<-,CrunchDataset-method` `startDate,CrunchDataset-method` `startDate<-,CrunchDataset-method` `endDate,CrunchDataset-method` `endDate<-,CrunchDataset-method` `id,CrunchDataset-method` `notes,CrunchDataset-method` `notes<-,CrunchDataset-method` `name<-,CrunchDeck-method` `description,CrunchDeck-method` `description<-,CrunchDeck-method` `description,Geodata-method` `name<-,Multitable-method` `name<-,ProjectFolder-method` `name,ProjectFolder-method` `name,ShojiObject-method` `name<-,VariableFolder-method` `alias,VariableTuple-method` `description,VariableTuple-method` `notes,VariableTuple-method` `name,CrunchVariable-method` `name<-,CrunchVariable-method` `id,CrunchVariable-method` `description,CrunchVariable-method` `description<-,CrunchVariable-method` `alias,CrunchVariable-method` `alias<-,CrunchVariable-method` `notes,CrunchVariable-method` `notes<-,CrunchVariable-method` `digits,CrunchVariable-method` `digits<-,NumericVariable-method` `digits<-,CrunchVariable-method` `uniformBasis,MultipleResponseVariable-method` `uniformBasis<-,MultipleResponseVariable-method`	Name, alias, and description for Crunch objects
`aliases()` `aliases<-`() `descriptions()` `descriptions<-`() `emails()` `types()` `timestamps()` `ids()` `ids<-`() `values()` `values<-`() `scriptBody()` `dates()` `dates<-`() `names(<AbstractCategories>)` `names<-`(<AbstractCategories>) `names(<BatchCatalog>)` `names(<CrunchDataFrame>)` `names(<CrunchCube>)` `notes(<CrunchCube>)` `names(<CrunchDataset>)` `names(<ShojiCatalog>)` `names<-`(<ShojiCatalog>) `names(<CrunchDeck>)` `names<-`(<CrunchDeck>) `names<-`(<MultitableCatalog>) `names(<ShojiOrder>)` `names(<OrderGroup>)` `names(<SlideCatalog>)` `names<-`(<SlideCatalog>) `names(<ArrayVariable>)` `names(<TabBookResult>)` `names(<MultitableResult>)` `notes(<VariableCatalog>)` `notes<-`(<VariableCatalog>) `names(<VersionCatalog>)`	Get and set names, aliases on Catalog-type objects
`refresh()`	Get a fresh copy from the server
`webApp()`	View a Crunch Object in the Web Application
`as.data.frame(<VariableCatalog>)` `as.data.frame(<ShojiCatalog>)` `as.data.frame(<BatchCatalog>)` `as.data.frame(<FilterCatalog>)` `as.data.frame(<UserCatalog>)`	as.data.frame method for catalog objects
`index()` `index<-`()	Get the body of a Catalog
`consent()` `with_consent()`	Give consent to do things that require permission
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
`forceVariableCatalog()`	Force variables catalog to be loaded
Other
`CrunchDataset-class` `CrunchDataset`	Crunch Datasets
`CrunchVariable-class` `NumericVariable-class` `NumericVariable` `CategoricalVariable-class` `CategoricalVariable` `TextVariable-class` `TextVariable` `DatetimeVariable-class` `DatetimeVariable` `CategoricalArrayVariable-class` `CategoricalArrayVariable` `MultipleResponseVariable-class` `MultipleResponseVariable` `NumericArrayVariable-class` `NumericArrayVariable`	Variables in Crunch
`DatasetOrder-class` `DatasetOrder` `DatasetGroup-class` `DatasetGroup`	Organize Datasets
`ShojiObject-class` `ShojiObject`	Mix-in class for multiple inheritance of variables and datasets.
`VariableCatalog-class` `VariableCatalog`	Collection of Variables within a Dataset
`VariableOrder-class` `VariableOrder` `VariableGroup-class` `VariableGroup`	Organize Variables within a Dataset
`crunch`	Crunch.io: instant, visual, collaborative data analysis
Internal
`envOrOption()` `set_crunch_opts()`	Get/set options (user-specified, in environment, or in R options)
`ContextManager()`	Context managers
`show()`	Show methods for Crunch objects
`temp.options()` `temp.option()`	Set some global options temporarily
`with(<contextManager>)`	Context manager's "with" method
`retry()`	Retry
`logout()` `login()` `resetPassword()`	DEPRECATED! Authenticate with the Crunch API
Data
`SO_schema`	Schema for the 2017 Stack Overflow developer survey
`SO_survey`	R users who responded to the 2017 Stack Overflow developer survey

Reference

Upload

Load

Dataset manipulation

Multiple datasets

Variable manipulation

Deriving variables

Array variables

Folders and organization

Crunch Automation

Analysis

Decks

Data presentation

Export

Geodata

Admin

Utility

API

Other

Internal

Data