Collapse

A collapse command summarizes data using aggregation functions applied to data that may be grouped by one or more variables. The resulting summary data is represented in a new dataset. See the collapse functions in the Function Library.

The details of implementation of caseWise and columnWise exclusion vary in each statistical package. The source language is indicated in this property for reference.

Properties

Name

Type

Description

OutputDatasetName

string

0..1

The name of a new, aggregated dataset to be created.

GroupByVariables

VariableReferenceBase

0..n

Variables used as keys to identify groups.

AggregateVariables

Compute

1..n

The expressions that compute the aggregations. An aggregation function should be used.

Weighting

Weight

0..1

Description of the weights to be used

CaseWise

string

0..1

Observations are not included if any variable is missing Valid values include: Stata

ColumnWise

string

0..1

Variables are not included if any value in a column is missing Valid values include: SPSS

Properties Inherited from TransformBase

Name

Type

Description

ProducesDataframe

DataframeDescription

0..n

Signify the dataframe which this transform produces.

ConsumesDataframe

DataframeDescription

0..n

Signify the dataframe which this transform acts upon.

Properties Inherited from CommandBase

Name

Type

Description

Command

string

1..1

The type of command

SourceInformation

SourceInformation

0..n

Information about the source of the command.

MessageText

string

0..n

Adds a message that can be displayed with the command.

Item Type Hierarchy

Relationships

The following identified item types reference this type.

stub