ganalytics (version 0.10.4)

Comparator: Comparator.

Description

Get or create a comparator used in / for an expression.

Set the comparator used in an expression.

Usage

Comparator(object, ...)
Comparator(object) <- value
var %starts_with% operand
var %ends_with% operand
var %contains% operand
var %matches% operand
var %between% operand
x %in% table
# S4 method for .var,.dimOperand
%matches%(var, operand)
# S4 method for .var,.dimOperand
%starts_with%(var, operand)
# S4 method for .var,.dimOperand
%ends_with%(var, operand)
# S4 method for .var,.dimOperand
%contains%(var, operand)
# S4 method for .var,.operand
%between%(var, operand)
# S4 method for .var,.operand
%in%(x, table)
# S4 method for .var,.operand
==(e1, e2)
# S4 method for .var,.operand
!=(e1, e2)
# S4 method for .var,.metOperand
>(e1, e2)
# S4 method for .var,.metOperand
<(e1, e2)
# S4 method for .var,.metOperand
>=(e1, e2)
# S4 method for .var,.metOperand
<=(e1, e2)
# S4 method for .expr
Comparator(object)
# S4 method for .expr
Comparator(object) <- value

Arguments

object

The object to be coerced to a '.Comparator' subclass or to obtain the comparator from.

...

Used by certain methods.

value

The value to set the comparator to.

var

dimension object

operand

operand object

x

Dimension or metric object

table

Operand object

e1

Dimension or metric object

e2

Operand object

Methods (by class)

• .expr: Return the comparator used within the supplied conditional expression.

• .expr: Replace the comparator of the supplied conditional expression.

%starts_with%

A condition where the dimension (LHS) matches values that start with the character string given by the operand (RHS).

%ends_with%

A condition where the dimension (LHS) matches values that end with the character string given by the operand (RHS).

%contains%

A condition where the dimension (LHS) matches values that contain the character string given by the operand (RHS).

%matches%

A condition where the dimension (LHS) matches a regular expression given by the operand (RHS).

%between%

A condition where the var (LHS) is within the lower and upper bounds specified by first and second vector value (respectively) of the operand (RHS).

%in%

A condition where the dimension (LHS) matches one of the values in the vector specified by the operand (RHS).