Skip to contents

Multivariate Piecewise linear model / piecewise regression

Source: R/mplm.R, R/print-export-mplm.R
mplm.Rd

The mplm() function computes a multivariate piecewise regression model.

Usage

mplm(
  data,
  dvar,
  mvar,
  pvar,
  model = c("W", "H-M", "B&L-B", "JW"),
  contrast = c("first", "preceding"),
  contrast_level = c(NA, "first", "preceding"),
  contrast_slope = c(NA, "first", "preceding"),
  trend = TRUE,
  level = TRUE,
  slope = TRUE,
  formula = NULL,
  update = NULL,
  na.action = na.omit,
  ...
)

# S3 method for class 'sc_mplm'
print(x, digits = "auto", std = FALSE, ...)

# S3 method for class 'sc_mplm'
export(
  object,
  caption = NA,
  footnote = NA,
  filename = NA,
  kable_styling_options = list(),
  kable_options = list(),
  nice = TRUE,
  std = FALSE,
  decimals = 2,
  ...
)

Arguments

data

A single-case data frame. See scdf() to learn about this format.

dvar

Character string with the name of the dependent variable. Defaults to the attributes in the scdf file.

mvar

Character string with the name of the measurement time variable. Defaults to the attributes in the scdf file.

pvar

Character string with the name of the phase variable. Defaults to the attributes in the scdf file.

model

Model used for calculating the dummy parameters (see Huitema & McKean, 2000). Default is model = "W". Possible values are: "B&L-B", "H-M", "W", and deprecated "JW".

contrast

Sets contrast_level and contrast_slope. Either "first", "preceding" or a contrast matrix.

contrast_level

Either "first", "preceding" or a contrast matrix. If NA contrast_level is a copy of contrast.

contrast_slope

Either "first", "preceding" or a contrast matrix. If NA contrast_level is a copy of contrast.

trend

A logical indicating if a trend parameters is included in the model.

level

A logical indicating if a level parameters is included in the model.

slope

A logical indicating if a slope parameters is included in the model.

formula

Defaults to the standard piecewise regression model. The parameter phase followed by the phase name (e.g., phaseB) indicates the level effect of the corresponding phase. The parameter 'inter' followed by the phase name (e.g., interB) adresses the slope effect based on the method provide in the model argument (e.g., "B&L-B"). The formula can be changed for example to include further variables into the regression model.

update

An easier way to change the regression formula (e.g., . ~ . + newvariable).

na.action

Defines how to deal with missing values.

...

Further arguments passed to the lm() function.

x

Object returned from mplm().

digits

The minimum number of significant digits to be use. If set to "auto" (default), values are predefined.

std

If TRUE, a table with standardized estimates is included.

object

An scdf or an object exported from a scan function.

caption

Character string with table caption. If left NA (default) a caption will be created based on the exported object.

footnote

Character string with table footnote. If left NA (default) a footnote will be created based on the exported object.

filename

String containing the file name. If a filename is given the output will be written to that file.

kable_styling_options

list with arguments passed to the kable_styling function.

kable_options

list with arguments passed to the kable function.

nice

If set TRUE (default) output values are rounded and optimized for publication tables.

decimals

Decimal places that are reported.

Value

modelCharacter string from function call (see arguments above).
contrastList with contrast definitions.
full.modelFull regression model list.
formulaFormula of the mplm model.

Functions

  • print(sc_mplm): Print results

  • export(sc_mplm): Export results as html

See also

Other regression functions: autocorr(), bplm(), corrected_tau(), hplm(), plm(), trend()

Author

Juergen Wilbert

Examples

res <- mplm(Leidig2018$`1a1`,
  dvar = c("academic_engagement", "disruptive_behavior")
)
print(res)
#> Multivariate piecewise linear model
#> 
#> Dummy model: W level = first, slope = first
#> Type III MANOVA 
#> Pillai = 0.35; F(6, 158) = 5.57; p = 0.000 
#> 
#>                        academic_engagement disruptive_behavior Pillai      F
#> Intercept                            2.771               0.849  0.284 15.475
#> Trend (mt)                          -0.216               0.082  0.032  1.275
#> Level phase B (phaseB)               2.340              -1.390  0.190  9.176
#> Slope phase B (interB)               0.219              -0.080  0.031  1.267
#>                            p
#> Intercept              0.000
#> Trend (mt)             0.285
#> Level phase B (phaseB) 0.000
#> Slope phase B (interB) 0.287
#> 
#> Formula: y ~ 1 + mt + phaseB + interB
## also report standardized coefficients:
print(res, std = TRUE)
#> Multivariate piecewise linear model
#> 
#> Dummy model: W level = first, slope = first
#> Type III MANOVA 
#> Pillai = 0.35; F(6, 158) = 5.57; p = 0.000 
#> 
#>                        academic_engagement disruptive_behavior Pillai      F
#> Intercept                            0.000               0.000  0.284 15.475
#> Trend (mt)                          -5.979               5.107  0.032  1.275
#> Level phase B (phaseB)               0.576              -0.767  0.190  9.176
#> Slope phase B (interB)               5.950              -4.897  0.031  1.267
#>                            p
#> Intercept              0.000
#> Trend (mt)             0.285
#> Level phase B (phaseB) 0.000
#> Slope phase B (interB) 0.287
#> 
#> Coefficients are standardized
#> Formula: y ~ 1 + mt + phaseB + interB