State: State

StateR Documentation

State

Description

State Class

Format

An R6Class generator object

Public fields

on_1b

On 1B character [optional]

on_2b

On 2B character [optional]

on_3b

On 3B character [optional]

inning

Inning integer [optional]

outs

Outs integer [optional]

top

Top character [optional]

bat_score

Bat Score integer [optional]

fld_score

Fld Score integer [optional]

bat_lineup_order

Bat Lineup Order integer [optional]

fld_lineup_order

Fld Lineup Order integer [optional]

pitch_number

Pitch Number integer [optional]

frame_runs_scored

Frame Runs Scored integer [optional]

Methods

Public methods


Method new()

Usage
State$new(
  on_1b = FALSE,
  on_2b = FALSE,
  on_3b = FALSE,
  inning = 1,
  outs = 0,
  top = TRUE,
  bat_score = 0,
  fld_score = 0,
  bat_lineup_order = 1,
  fld_lineup_order = 1,
  pitch_number = 0,
  frame_runs_scored = 0,
  ...
)

Method toJSON()

Usage
State$toJSON()

Method fromJSON()

Usage
State$fromJSON(StateJson)

Method toJSONString()

Usage
State$toJSONString()

Method fromJSONString()

Usage
State$fromJSONString(StateJson)

Method clone()

The objects of this class are cloneable with this method.

Usage
State$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


singlearity-sports/singlearity-R documentation built on April 21, 2022, 3:48 a.m.