default_times: Calculate default initial treatment time and follow-up time.

View source: R/calc_BCSMD.R

default_timesR Documentation

Calculate default initial treatment time and follow-up time.

Description

Calculate the default initial treatment time and follow-up time that are used to define and estimate the between-case standardized mean differences for multiple baseline designs and variations.

Usage

default_times(
  design,
  case,
  phase,
  session,
  cluster = NULL,
  series = NULL,
  treatment_name = NULL,
  data = NULL
)

Arguments

design

Character string to specify whether data comes from a treatment reversal ("TR"), multiple baseline across participants ("MBP"), replicated multiple baseline across behaviors ("RMBB"), or clustered multiple baseline across participants ("CMB").

case

vector of case indicators or name of a character or factor vector within data indicating unique cases.

phase

vector of treatment indicators or name of a character or factor vector within data indicating unique treatment phases.

session

vector of measurement occasions or name of numeric vector within data of measurement times.

cluster

(Optional) vector of cluster indicators or name of a character or factor vector within data indicating clusters.

series

(Optional) vector of series indicators or name of a character or factor vector within data indicating series.

treatment_name

(Optional) character string corresponding to the name of the treatment phase.

data

(Optional) dataset to use for analysis. Must be a data.frame.

Value

A list of time range, default initial treatment time, and default follow-up time.

Note

If treatment_name is left null, it will choose the second level of the phase variable to be the treatment phase.

Examples

data(Laski)
default_times(design = "MBP", 
              case = case, phase = treatment, session = time, 
              data = Laski)

data(Thiemann2001)
default_times(design = "RMBB", 
              case = case, series = series, 
              phase = treatment, session = time, 
              data = Thiemann2001)

data(Bryant2018)
default_times(design = "CMB", 
              cluster = group, case = case, 
              phase = treatment, session = session, 
              data = Bryant2018)
              

scdhlm documentation built on May 29, 2024, 12:11 p.m.