crunch-extract: Extract and modify Crunch objects

In crunch: Crunch.io Data Tools

Extract and modify Crunch objects

Description

Extract and modify Crunch objects

This function is no-op because the items are already updated on the server with other methods called prior to it.

Usage

## S4 method for signature 'AbstractCategories,ANY,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'AbstractCategories,character,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'AbstractCategories,numeric,ANY'
x[i, j, ..., drop = TRUE]

## S4 replacement method for signature 'AbstractCategories,character,ANY,ANY'
x[i, j, ...] <- value

## S4 method for signature 'AbstractCategories,character'
x[[i, j, ...]]

## S4 replacement method for signature 'AbstractCategories,character,ANY,ANY'
x[[i, j, ...]] <- value

## S4 method for signature 'AbstractCategory'
x$name

## S4 replacement method for signature 'AbstractCategory'
x$name <- value

## S4 method for signature 'ScriptCatalog,numeric'
x[[i, j, ...]]

## S4 replacement method for signature 'Categories,ANY,ANY,ANY'
x[i, j, ...] <- value

## S3 method for class 'CrunchDataFrame'
x[i, j, drop = TRUE]

## S3 replacement method for class 'CrunchDataFrame'
x[i, j] <- value

## S3 method for class 'CrunchDataFrame'
x[[i]]

## S3 replacement method for class 'CrunchDataFrame'
x[[i]] <- value

## S3 method for class 'CrunchDataFrame'
x$i

## S3 replacement method for class 'CrunchDataFrame'
x$i <- value

## S4 method for signature 'CubeDims,ANY,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'CrunchCube,ANY,ANY'
x[i, j, ..., drop = TRUE]

## S4 replacement method for signature 'TransformsList,ANY,missing,'NULL''
x[[i, j]] <- value

## S4 method for signature 'DatasetCatalog,numeric'
x[[i, j, ...]]

## S4 replacement method for signature 'DatasetCatalog,character,missing,DatasetTuple'
x[[i, j]] <- value

## S4 method for signature 'CrunchDataset,ANY,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'CrunchDataset,logical,missing'
x[i, j, ..., drop = FALSE]

## S4 method for signature 'CrunchDataset,character,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'CrunchDataset,VariableGroup,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'CrunchDataset,VariableOrder,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'CrunchDataset,missing,ANY'
x[i, j, ..., drop = FALSE]

## S4 method for signature 'CrunchDataset,CrunchLogicalExpr,missing'
x[i, j, ..., drop = FALSE]

## S4 method for signature 'CrunchDataset,CrunchLogicalExpr,ANY'
x[i, j, ..., drop = FALSE]

## S4 method for signature 'CrunchDataset'
subset(x, ...)

## S4 method for signature 'CrunchDataset,ANY'
x[[i, ..., drop = FALSE]]

## S4 method for signature 'CrunchDataset,character'
x[[i, ..., drop = FALSE]]

## S4 method for signature 'CrunchDataset'
x$name

## S4 replacement method for signature 'CrunchDataset,character,missing,CrunchVariable'
x[[i]] <- value

## S4 replacement method for signature 'CrunchDataset,ANY,missing,CrunchVariable'
x[[i]] <- value

## S4 replacement method for signature 'CrunchDataset,character,missing,ANY'
x[[i]] <- value

## S4 replacement method for signature 'CrunchDataset,ANY,ANY,ANY'
x[[i]] <- value

## S4 replacement method for signature 'CrunchDataset,character,missing,'NULL''
x[[i]] <- value

## S4 replacement method for signature 'CrunchDataset,ANY,missing,'NULL''
x[[i]] <- value

## S4 replacement method for signature 'CrunchDataset'
x$name <- value

## S4 replacement method for signature 'CrunchDataset,character,missing,CrunchGeography'
x[[i]] <- value

## S4 replacement method for signature 'CrunchDataset,ANY,missing,CrunchGeography'
x[[i]] <- value

## S4 replacement method for signature 'CrunchDataset,ANY,missing,list'
x[i, j] <- value

## S4 replacement method for signature 'CrunchDataset,ANY,missing,CrunchDataset'
x[i, j] <- value

## S4 replacement method for signature 'CrunchDataset,CrunchExpr,ANY,ANY'
x[i, j] <- value

## S4 method for signature 'ShojiCatalog,character,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'ShojiCatalog,numeric,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'ShojiCatalog,logical,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'ShojiCatalog,ANY,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'ShojiCatalog,ANY'
x[[i, j, ...]]

## S4 method for signature 'ShojiCatalog,character'
x[[i, j, ...]]

## S4 method for signature 'ShojiCatalog'
x$name

## S4 replacement method for signature 'ShojiCatalog'
x$name <- value

## S4 replacement method for signature 'ShojiCatalog,ANY,missing,ShojiCatalog'
x[i, j] <- value

## S4 method for signature 'DeckCatalog,ANY'
x[[i, j, ...]]

## S4 method for signature 'DeckCatalog,character'
x[[i, j, ...]]

## S4 replacement method for signature 'DeckCatalog,ANY,missing,CrunchDeck'
x[[i, j]] <- value

## S4 replacement method for signature 'CrunchDeck,ANY,missing,AnalysisCatalog'
x[[i, j]] <- value

## S4 replacement method for signature 'SlideCatalog,ANY,missing,CrunchSlide'
x[[i, j]] <- value

## S4 replacement method for signature 'AnalysisCatalog,ANY,missing,Analysis'
x[[i, j]] <- value

## S4 method for signature 'CrunchDeck,ANY'
x[[i, j, ...]]

## S4 replacement method for signature 'CrunchDeck,ANY,ANY,ANY'
x[[i, j]] <- value

## S4 method for signature 'CrunchExpr,CrunchLogicalExpr,ANY'
x[i, j, ..., drop = FALSE]

## S4 method for signature 'CrunchExpr,logical,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'CrunchExpr,numeric,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'FilterCatalog,numeric'
x[[i, j, ...]]

## S4 replacement method for signature 'FilterCatalog,character,missing,CrunchLogicalExpr'
x[[i, j]] <- value

## S4 replacement method for signature 'FilterCatalog,numeric,missing,CrunchLogicalExpr'
x[[i, j]] <- value

## S4 replacement method for signature 'FilterCatalog,character,missing,CrunchFilter'
x[[i, j]] <- value

## S4 replacement method for signature 'FilterCatalog,numeric,missing,CrunchFilter'
x[[i, j]] <- value

## S4 method for signature 'MemberCatalog,character'
x[[i, j, ...]]

## S4 replacement method for signature 'MemberCatalog,ANY,missing,ANY'
x[[i, j]] <- value

## S4 replacement method for signature 'MemberCatalog,character,missing,'NULL''
x[[i, j]] <- value

## S4 method for signature 'MultitableCatalog,numeric'
x[[i, j, ...]]

## S4 replacement method for signature 'MultitableCatalog,character,missing,formula'
x[[i, j]] <- value

## S4 replacement method for signature 'MultitableCatalog,numeric,missing,formula'
x[[i, j]] <- value

## S4 replacement method for signature 'MultitableCatalog,ANY,missing,Multitable'
x[[i, j]] <- value

## S4 replacement method for signature 'MultitableCatalog,ANY,missing,'NULL''
x[[i, j]] <- value

## S4 method for signature 'PermissionCatalog,character'
x[[i, j, ...]]

## S4 replacement method for signature 'ProjectFolder,character,missing,list'
x[[i, j]] <- value

## S4 replacement method for signature 'ProjectFolder,character,missing,ProjectFolder'
x[[i, j]] <- value

## S4 method for signature 'ShojiFolder,numeric'
x[[i, ..., drop = FALSE]]

## S4 method for signature 'ShojiFolder,character'
x[[i, ..., drop = FALSE]]

## S4 method for signature 'ShojiOrder,ANY,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'ShojiOrder,character,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'ShojiOrder,ANY'
x[[i, j, ...]]

## S4 method for signature 'ShojiOrder,character'
x[[i, j, ...]]

## S4 method for signature 'ShojiOrder'
x$name

## S4 replacement method for signature 'ShojiOrder,character,missing,ShojiOrder'
x[i, j] <- value

## S4 replacement method for signature 'ShojiOrder,ANY,missing,ShojiOrder'
x[i, j] <- value

## S4 replacement method for signature 'ShojiOrder,character,missing,list'
x[[i, j]] <- value

## S4 replacement method for signature 'ShojiOrder,character,missing,character'
x[[i, j]] <- value

## S4 replacement method for signature 'ShojiOrder,character,missing,OrderGroup'
x[[i, j]] <- value

## S4 replacement method for signature 'ShojiOrder,ANY,missing,OrderGroup'
x[[i, j]] <- value

## S4 replacement method for signature 'ShojiOrder,ANY,missing,ANY'
x[[i, j]] <- value

## S4 replacement method for signature 'ShojiOrder,ANY,missing,'NULL''
x[[i, j]] <- value

## S4 replacement method for signature 'ShojiOrder,character,missing,'NULL''
x[[i, j]] <- value

## S4 replacement method for signature 'ShojiOrder,character,missing,ShojiOrder'
x[[i, j]] <- value

## S4 replacement method for signature 'ShojiOrder'
x$name <- value

## S4 method for signature 'OrderGroup,ANY,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'OrderGroup,character,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'OrderGroup,character'
x[[i, j, ...]]

## S4 method for signature 'OrderGroup,ANY'
x[[i, j, ...]]

## S4 method for signature 'OrderGroup'
x$name

## S4 replacement method for signature 'OrderGroup,character,missing,list'
x[[i, j]] <- value

## S4 replacement method for signature 'OrderGroup,character,missing,character'
x[[i, j]] <- value

## S4 replacement method for signature 'OrderGroup,character,missing,ShojiOrder'
x[[i, j]] <- value

## S4 replacement method for signature 'OrderGroup,character,missing,OrderGroup'
x[[i, j]] <- value

## S4 replacement method for signature 'OrderGroup,ANY,missing,OrderGroup'
x[[i, j]] <- value

## S4 replacement method for signature 'OrderGroup,numeric,missing,'NULL''
x[[i, j]] <- value

## S4 replacement method for signature 'OrderGroup,character,missing,'NULL''
x[[i, j]] <- value

## S4 replacement method for signature 'OrderGroup'
x$name <- value

## S4 method for signature 'SlideCatalog,ANY'
x[[i, j, ...]]

## S4 replacement method for signature 'SlideCatalog,numeric,missing,CrunchSlide'
x[[i, j]] <- value

## S4 method for signature 'CrunchAnalysisSlide,ANY'
x[[i, j, ...]]

## S4 replacement method for signature 'CrunchAnalysisSlide,ANY,ANY,ANY'
x[[i, j]] <- value

## S4 method for signature 'AnalysisCatalog,ANY'
x[[i, j, ...]]

## S4 replacement method for signature 'AnalysisCatalog,numeric,missing,formula'
x[[i, j]] <- value

## S4 replacement method for signature 'AnalysisCatalog,numeric,missing,Analysis'
x[[i, j]] <- value

## S4 replacement method for signature 'AnalysisCatalog,numeric,missing,list'
x[[i, j]] <- value

## S4 method for signature 'Subvariables,character'
x[[i, j, ...]]

## S4 method for signature 'Subvariables,numeric'
x[[i, j, ...]]

## S4 method for signature 'Subvariables,character,ANY'
x[i, j, ..., drop = TRUE]

## S4 replacement method for signature 'Subvariables,character,missing,CrunchVariable'
x[[i]] <- value

## S4 replacement method for signature 'Subvariables,ANY,missing,CrunchVariable'
x[[i]] <- value

## S4 replacement method for signature 'Subvariables,ANY,missing,'NULL''
x[[i]] <- value

## S4 replacement method for signature 'Subvariables,ANY,missing,ANY'
x[[i]] <- value

## S4 replacement method for signature 'Subvariables,character,missing,Subvariables'
x[i] <- value

## S4 replacement method for signature 'Subvariables,ANY,missing,Subvariables'
x[i] <- value

## S4 replacement method for signature 'Subvariables,ANY,missing,ANY'
x[i] <- value

## S4 method for signature 'ArrayVariable,character,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'ArrayVariable,missing,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'ArrayVariable,missing,character'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'ArrayVariable,ANY'
x[[i, j, ...]]

## S4 method for signature 'ArrayVariable,character'
x[[i, j, ...]]

## S4 method for signature 'ArrayVariable'
x$name

## S4 replacement method for signature 'ArrayVariable,ANY,missing,ANY'
x[[i]] <- value

## S4 replacement method for signature 'ArrayVariable,character,missing,ANY'
x[[i]] <- value

## S4 replacement method for signature 'ArrayVariable'
x$name <- value

## S4 method for signature 'TabBookResult,numeric'
x[[i, j, ...]]

## S4 method for signature 'TabBookResult,character'
x[[i, j, ...]]

## S4 method for signature 'MultitableResult,ANY'
x[[i, j, ...]]

## S4 method for signature 'TeamCatalog,numeric'
x[[i, j, ...]]

## S4 replacement method for signature 'TeamCatalog,character,missing,list'
x[[i, j]] <- value

## S4 replacement method for signature 'TeamCatalog,character,missing,CrunchTeam'
x[[i, j]] <- value

## S4 method for signature 'UserCatalog,character,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'UserCatalog,character'
x[[i, j, ...]]

## S4 method for signature 'VariableCatalog,numeric'
x[[i, j, ...]]

## S4 replacement method for signature 'VariableCatalog,character,missing,VariableTuple'
x[[i, j]] <- value

## S4 replacement method for signature 'VariableCatalog,character,missing,CrunchVariable'
x[[i, j]] <- value

## S4 method for signature 'VariableCatalog,VariableOrder,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'VariableCatalog,VariableGroup,ANY'
x[i, j, ..., drop = TRUE]

## S4 replacement method for signature 
## 'VariableCatalog,VariableOrder,missing,VariableCatalog'
x[i, j] <- value

## S4 replacement method for signature 
## 'VariableCatalog,VariableGroup,missing,VariableCatalog'
x[i, j] <- value

## S4 replacement method for signature 'VariableOrder,character,missing,CrunchDataset'
x[[i, j]] <- value

## S4 replacement method for signature 'VariableGroup,character,missing,CrunchDataset'
x[[i, j]] <- value

## S4 replacement method for signature 'CrunchVariable,ANY,missing,ANY'
x[i, j] <- value

## S4 replacement method for signature 'CrunchVariable,ANY,missing,'NULL''
x[i, j] <- value

## S4 replacement method for signature 'TextVariable,ANY,missing,character'
x[i, j] <- value

## S4 replacement method for signature 'NumericVariable,ANY,missing,numeric'
x[i, j] <- value

## S4 replacement method for signature 'DatetimeVariable,ANY,missing,Date'
x[i, j] <- value

## S4 replacement method for signature 'DatetimeVariable,ANY,missing,POSIXt'
x[i, j] <- value

## S4 replacement method for signature 'CrunchVariable,ANY,missing,CrunchExpr'
x[i, j] <- value

## S4 replacement method for signature 'CrunchVariable,ANY,missing,CrunchVariable'
x[i, j] <- value

## S4 replacement method for signature 'CrunchVariable,ANY,missing,CrunchLogicalExpr'
x[i, j] <- value

## S4 replacement method for signature 'CategoricalVariable,ANY,missing,numeric'
x[i, j] <- value

## S4 replacement method for signature 'CategoricalVariable,ANY,missing,character'
x[i, j] <- value

## S4 replacement method for signature 'CategoricalVariable,ANY,missing,factor'
x[i, j] <- value

## S4 replacement method for signature 'CategoricalArrayVariable,ANY,missing,numeric'
x[i, j] <- value

## S4 replacement method for signature 'CategoricalArrayVariable,ANY,missing,character'
x[i, j] <- value

## S4 replacement method for signature 'CategoricalArrayVariable,ANY,missing,factor'
x[i, j] <- value

## S4 replacement method for signature 'CrunchVariable,ANY,missing,logical'
x[i, j] <- value

## S4 replacement method for signature 'CrunchVariable,ANY'
is.na(x) <- value

## S4 method for signature 'CrunchVariable,CrunchExpr,ANY'
x[i, j, ..., drop = FALSE]

## S4 method for signature 'CrunchVariable,numeric,ANY'
x[i, j, ..., drop = TRUE]

## S4 method for signature 'CrunchVariable,logical,ANY'
x[i, j, ..., drop = TRUE]

Arguments

x	a Crunch object (Dataset, Variable, CrunchExpr, Catalog, CrunchCube, etc.)
i	The elements to extract; as with R, this can generally be (1) a logical vector of length matching x; (2) a character vector of appropriate length, which can generally be URLs or also names, aliases, or other identifier; (3) integer indices, potentially negative, to select. Datasets and Variables can also be subset by CrunchExpr. Note that when subsetting Datasets and variables by R vectors, the input i is turned into a CrunchExpr so that it can be used in API queries.
j	For two-dimensional objects, elements to take from the columnar dimension. Note that Datasets work like data.frames in that you can extract columns either by ds[, j] or by the list-like ds[i] (with no comma).
...	additional arguments supported by some methods. For example, some catalogs support a secondary vector of elements to match against like emails(x) or owners(x); by default this is names(x). This lets (for example) you to look up variables by URL but fall back to name.
drop	Ignored and always assumed FALSE
value	For updating, an object of the appropriate class and size to insert. This is generally the same class of object you would get from the extract method; i.e. for x[[i]] <- value, value must be the same class as x[[i]]. Exceptions include ds$var <- VariableDefinition(...) to create a new variable, and ds$var[i] <- value, which can take R vectors and CrunchExpr.
name	for $, the same as i for [[

Value

[ generally returns a subset of x, same class and "self" URL; when subsetting with a CrunchExpr, the expression is recorded in an attribute of the object. [[ and $ return appropriate extractions from x, wherever possible without making an additional API request. The assignment methods return x appropriately updated. Most assignment methods do not make an API request except where they clearly are used to create a new entity (as in assigning a variable definition to a Dataset); for editing metadata attributes, these methods generally assume that the API request to set the changes on the server happens in a different method (e.g. in names(variables(ds)[1:5]) <- value, assignment happens in the ⁠names<-⁠ method).

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