summary.NMdata: summary method for NMdata objects

View source: R/summary_NMdata.R

summary.NMdataR Documentation

summary method for NMdata objects

Description

summary method for NMdata objects

Usage

## S3 method for class 'NMdata'
summary(object, ...)

Arguments

object

An NMdata object (from NMscanData).

...

Only passed to the summary generic if object is missing NMdata meta data (this should not happen anyway).

Details

The subjects are counted conditioned on the nmout column. If only id-level output tables are present, there are no nmout=TRUE rows. This means that in this case it will report that no IDs are found in output. The correct statement is that records are found for zero subjects in output tables.

Value

A list with summary information on the NMdata object.


NMdata documentation built on Nov. 11, 2023, 5:07 p.m.