BuildClassificationValueSegment: Build a Classification Value Segment

Description Usage Arguments Details Value Examples

View source: R/BuildClassificationValueSegment.R

Description

Function to build a classification value segment for use in segmenting reports.

Usage

1
2
BuildClassificationValueSegment(element, search.keywords, classification = "",
  search.type = "OR")

Arguments

element

List of elements on which to base the segment

search.keywords

List of search keyword vectors for each element (Use ^ to pin to start and $ to pin to end, or both to specify exact match)

classification

(optional) Classification breakdown name for the element (defaults to the element name)

search.type

How to combine the keywords list. This defaults to 'OR' if it is not specified.

Details

Function to build a classification value segment for use in segmenting reports.

Multiple segments can be combined in a list. Note that search can only be applied to a breakdown classification and not an element value.

Value

Segment definition for use with Queue* functions

Examples

1
2
3
4
5
6
7
## Not run: 
vistor_segment <- BuildClassificationValueSegment(element,
                                                  search.keywords,
                                                  classification,
                                                  search.type)

## End(Not run)

RSiteCatalyst documentation built on Nov. 6, 2019, 5:09 p.m.