describe_relationship: Describe relationship between two dependent groups

Description Usage Arguments Examples

View source: R/describe_relationship.R

Description

describe_relationship provides numerous descriptive estimators and bootstrap confidence intervals for relationship between paired predictor and outcome groups. describe_relationship function is a "wrapper" for bmbstats function.

Usage

1
2
3
4
5
6
7
8
9
describe_relationship(
  predictor,
  outcome,
  SESOI_lower = SESOI_lower_dependent_func,
  SESOI_upper = SESOI_upper_dependent_func,
  estimator_function = relationship_lm_estimators,
  control = model_control(),
  na.rm = FALSE
)

Arguments

predictor

Numeric vector

outcome

Vector

SESOI_lower

Lower smallest effect size of interest threshold

SESOI_upper

Upper smallest effect size of interest threshold

estimator_function

Function that takes predictor, outcome, and na.rm parameters and return named numeric vector with parameter estimates. Default is relationship_lm_estimators. User can write their own function with needed estimators for which bootstrap confidence intervals are needed

control

Control object returned from model_control function. Use boot_type, boot_samples, boot_strata to setup bootstrap.

na.rm

Should NAs be removed? Default is FALSE

Examples

1
2
3
4
5
data("yoyo_mas_data")
predictor <- yoyo_mas_data$YoYoIR1
outcome <- yoyo_mas_data$MAS

describe_relationship(predictor, outcome, SESOI_lower = -0.5, SESOI_upper = 0.5)

mladenjovanovic/bmbstats documentation built on Aug. 5, 2020, 4:20 p.m.