pfa_document {aurelius}R Documentation

pfa_document

Description

Create a complete PFA document as a list-of-lists. Composing with the JSON function creates a PFA file on disk.

Usage

pfa_document(input, output, action, cells = NULL, pools = NULL,
  fcns = NULL, validate = FALSE, name = NULL, method = NULL,
  begin = NULL, end = NULL, zero = NULL, merge = NULL,
  randseed = NULL, doc = NULL, version = NULL, metadata = NULL,
  options = NULL, env = parent.frame())

Arguments

input

input schema, which is an Avro schema as list-of-lists (created by avro_* functions)

output

output schema, which is an Avro schema as list-of-lists (created by avro_* functions)

action

R commands wrapped as an expression (see R's built-in expression function)

cells

named list of cell specifications (see the pfa_cell function)

pools

named list of pool specifications (see the pfa_cell function)

fcns

named list of R commands, wrapped as expressions

validate

a logical indicating whether the generated PFA document should be validated using Titus-in-Aurelius function pfa_engine

name

optional name for the scoring engine (string)

method

"map", "emit", "fold", or NULL (for "map")

begin

R commands wrapped as an expression

end

R commands wrapped as an expression

zero

list-of-lists representing the initial value for a "fold"'s tally

merge

R commands wrapped as an expression

randseed

optional random number seed (integer) for ensuring that the scoring engine is deterministic

doc

optional model documentation string

version

optional model version number (integer)

metadata

optional named list of strings to store model metadata

options

optional list-of-lists to specify PFA options

env

environment for resolving unrecognized symbols as substitutions

Value

a list of lists representing a complete PFA document

Source

pfa_engine.R

See Also

pfa_engine

Examples

pfa_document(avro_double, avro_double, expression(input + 10))

[Package aurelius version 0.8.4 Index]