Causata (version 4.2-0)

VariableDefinition: Defines information for creating variables in Causata.

Description

This function defines variable information, including the name, description, and labels, for creating new variables in Causata.

Usage

VariableDefinition(name, display.name = name, description = name,  labels = list(),  author = Sys.info()[["user"]],  timestamp = as.integer(1000 * as.numeric(format(Sys.time(), "%H%M%OS3"))),  archived = FALSE,  categorizing.attribute = "",  output.value.count = -1, data.type = "double")

Arguments

name

The variable system name. Only letters, numbers, and dashes are allowed in the name, e.g. most-recent-product-viewed.

display.name

The variable display name as it will be shown in Causata, e.g. Most Recent Product Viewed.

description

A brief description of the variable, which will be displayed in Causata.

labels

A list of optional variable labels, used for categorization.

author

The variable author name.

timestamp

The timestamp for when the variable was created. The format is milliseconds from the Unix epoch, Jan 1 1970, 00:00 UTC.

archived

A boolean indicating if this variable is archived or not.

categorizing.attribute

Name of the Causata attribute used to categorize the output.

output.value.count

The number of output values.

data.type

The data type of the output. Allowable values are "double", "float", "long", "integer", or "short".

Value

An object of class VariableDefinition is returned.

Details

Consult your Causata documentation for more information about variables in Causata.

See Also

UploadModel

Examples

variable.definition <- VariableDefinition(name="most-recent-product-viewed", 
  display.name="Most Recent Product Viewed",
  description="The most recent product viewed online.",
  labels=list("online","products"))