summary.LPJmLData: LPJmLData object summary

View source: R/LPJmLData_stats.R

summary.LPJmLDataR Documentation

LPJmLData object summary

Description

Function to get the summary of the data array of an LPJmLData object. See also summary.

Usage

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

Arguments

object

LPJmLData object

...

Further arguments:

  • dimension for which a summary is printed for every element (in style of matrix summary). Default is dimension = "band". Choose from available dimensions like "time" or "cell".

  • subset list of array dimension(s) as name/key and corresponding subset vector as value, e.g. ⁠list(cell = c(27411:27415)⁠. More information at subset.LPJmLData().

  • cutoff (logical) If TRUE summary for dimension elements > 16 are cut off.

  • Additional arguments to be passed on to summary.

Value

Summary for object of class matrix (see summary) for selected dimension(s) and if defined subset.


lpjmlkit documentation built on March 31, 2023, 9:35 p.m.