GraphTargetData: Graph target data series across time

View source: R/GraphTargetData.R

GraphTargetDataR Documentation

Graph target data series across time

Description

This function graphs the target data series across time.

Usage

GraphTargetData(
  time = SCUL.input$time,
  TreatmentBeginsAt = SCUL.input$TreatmentBeginsAt,
  y = SCUL.input$y,
  OutputFilePath = SCUL.input$OutputFilePath,
  save.figure = FALSE
)

Arguments

time

A dataframe that is a column vector (T by 1) with the running time variable. Must be sorted by time (oldest to most recent). Default is taken from SCUL.input$time.

TreatmentBeginsAt

An integer indicating the time period (<T) in which treatment begins. Defailt is taken from SCUL.input$TreatmentBeginsAt.

y

A dataframe that is a column vector (T by 1) containing the target variable of interest. Must be sorted by time (oldest to most recent). Default is SCUL.input$y.

OutputFilePath

A file path to store output. Default is taken from SCUL.input$OutputFilePath

save.figure

Boolean, set to TRUE if you want output saved as figure to OutputFilePath automatically. Default is FALSE

Value

FullPlotFilePath A plot of the target varibale across time, with the pre and post treatment periods clearly marked


hollina/scul documentation built on Oct. 15, 2023, 5:43 p.m.