preprocess_SCD: Clean Single Case Design Data

Description Usage Arguments Value Note Examples

View source: R/preprocess-function.R

Description

Clean single case design data for treatment reversal and multiple baseline designs.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
preprocess_SCD(
  case,
  phase,
  session,
  outcome,
  design,
  center = 0,
  round_session = TRUE,
  treatment_name = NULL,
  data = NULL
)

Arguments

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.

outcome

vector of outcome data or name of numeric vector of outcome data within data.

design

Character string to specify whether data comes from a treatment reversal, "TR", or multiple baseline, "MB", design.

center

Numeric value for the centering value for session. Default is 0.

round_session

Logical indicating whether to round session to the nearest integer. Defaults to TRUE.

treatment_name

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

data

(Optional) dataset to be cleaned. Must be a data.frame.

Value

A cleaned SCD dataset that can be used for model fitting and effect size calculation.

Note

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

Examples

1
2
3
4
5
6
data(Laski)
preprocess_SCD(case = case, phase = treatment,
               session = time, outcome = outcome, 
               design = "MB", center = 4, data = Laski)

          

scdhlm documentation built on Jan. 13, 2021, 7:10 p.m.