summary.complr: Create a Summary of a 'complr' object

View source: R/summary.R

summary.complrR Documentation

Create a Summary of a complr object

Description

Create a Summary of a complr object

Usage

## S3 method for class 'complr'
summary(object, weight = c("equal", "proportional"), ...)

Arguments

object

An object of class complr.

weight

A character value specifying the weight to use in calculation of the reference composition. If "equal", give equal weight to units (e.g., individuals). If "proportional", weights in proportion to the frequencies of units being averaged (e.g., observations across individuals). Default is equal.

...

generic argument, not in use.

Examples

cilr <- complr(data = mcompd, sbp = sbp, 
               parts = c("TST", "WAKE", "MVPA", "LPA", "SB"), 
               idvar = "ID")
summary(cilr)

florale/multilevelcoda documentation built on May 1, 2024, 10:15 a.m.