Skip to contents

Summarize an APA/FACETS table object

Source: R/api-reports.R
summary.apa_table.Rd

Summarize an APA/FACETS table object

Usage

# S3 method for class 'apa_table'
summary(object, digits = 3, top_n = 8, ...)

Arguments

object

Output from apa_table().

digits

Number of digits used for numeric summaries.

top_n

Maximum numeric columns shown in numeric_profile.

...

Reserved for generic compatibility.

Value

An object of class summary.apa_table.

Details

Compact summary helper for QA of table payloads before manuscript export.

Interpreting output

  • overview: table size/composition and missingness.

  • numeric_profile: quick distribution summary of numeric columns.

  • caption/note: text metadata readiness.

Typical workflow

  1. Build table with apa_table().

  2. Run summary(tbl) and inspect overview.

  3. Use plot.apa_table() for quick numeric checks if needed.

See also

apa_table(), plot()

Examples

toy <- load_mfrmr_data("example_core")
fit <- fit_mfrm(toy, "Person", c("Rater", "Criterion"), "Score", method = "JML", maxit = 25)
tbl <- apa_table(fit, which = "summary")
summary(tbl)
#> APA Table Summary
#>  Branch Style   Which Rows Columns NumericColumns MissingValues
#>     apa   apa summary    1      11              8             0
#> 
#> Caption
#>  - Table 1
#> Facet Summary (Measures, Precision, Fit, Reliability)
#> 
#> Note
#>  - Measures are reported in logits; higher values indicate more of the modeled trait for that facet. Model S.E. = exploratory standard error; Real S.E. = fit-adjusted exploratory standard error; MnSq = mean-square fit. Model = RSM; estimation = JMLE; N = 768 observations from 48 persons on a 4-category scale (1-4).
#> 
#> Numeric profile
#>      Column N    Mean SD     Min     Max
#>         AIC 1 1755.90 NA 1755.90 1755.90
#>         BIC 1 2020.59 NA 2020.59 2020.59
#>  Categories 1    4.00 NA    4.00    4.00
#>      Facets 1    2.00 NA    2.00    2.00
#>  Iterations 1   67.00 NA   67.00   67.00
#>      LogLik 1 -820.95 NA -820.95 -820.95
#>           N 1  768.00 NA  768.00  768.00
#>     Persons 1   48.00 NA   48.00   48.00