matchatr
  1. Reference
  2. print.matchatr_design
  • Home
  • Getting started
    • Introduction
  • Classical odds ratios
    • Unmatched case-control odds ratios
    • Matched case-control odds ratios
    • Multiple case / control groups
  • Risk-set designs
    • Nested case-control
  • Reference
    • case_cohort
    • contrast
    • counter_matched
    • matcha
    • matched_cc
    • nested_cc
    • print.matchatr_design
    • print.matchatr_fit
    • print.matchatr_homogeneity
    • print.matchatr_result
    • sample_ncc
    • summary.matchatr_fit
    • test_homogeneity
    • tidy.matchatr_fit
    • tidy.matchatr_homogeneity
    • tidy.matchatr_result
    • two_phase
    • unmatched_cc
  • News
  • License
  • Citation

On this page

  • Print a matchatr design
    • Description
    • Usage
    • Arguments
    • Value
    • See Also
    • Examples

Code Links

  1. Reference
  2. print.matchatr_design

Print a matchatr design

Description

Displays a compact summary of a matchatr_design object: the sampling structure, the columns it references, the matching ratio and prevalence when present, and the weighting scheme it will use.

Usage

## S3 method for class 'matchatr_design'
print(x, ...)

Arguments

x A matchatr_design object.
… Unused; present for S3 consistency.

Value

Invisibly returns x.

See Also

unmatched_cc(), matched_cc(), nested_cc(), case_cohort()

Examples

library("matchatr")

print(matched_cc(strata = "set", ratio = 2))
<matchatr_design>
 Type:       Matched case-control
 Strata:     set
 Ratio:      2:1
 Weights:    none
print(unmatched_cc(prevalence = 0.02))
<matchatr_design>
 Type:       Unmatched case-control
 Prevalence: 0.02 (q0)
 Weights:    case-control (q0)