getHOT: Calculate HOT metric results for given TS object

In GHI-UW/HOT: The Health-Oriented Transportation (HOT) Model

Description

This function takes a TravelSurvey object, a HOT metric to calculate, and any additional variables to feed into that metric calculation

Usage

getHOT(ts, metric, mode = NULL, scenario = NULL, author = NULL,
  income = NULL)

Arguments

ts	TravelSurvey object
metric	HOT metric used for analysis. Options available: participation, frequency, proportion, intensity, duration, trips, CRA
mode	Required if HOT metric is stratified by mode of transit. Options available: walk, cycle, other
scenario	Required if HOT metric is stratified by participation scenario. Options available: rho.s.1, rho.s.2
author	Required if HOT metric is stratified by participation scenario. Options available: Arem, Lear, Wen
income	Required if HOT metric is stratified by participation scenario. Options available: High, Upper-middle, Lower-middle, Low

Value

Results dataframe stratified by location

GHI-UW/HOT documentation built on June 14, 2019, 1:21 a.m.