summary {SDAR}

summarize strata class objects

Description

The summary method displays standard information about a strata class object. It displays a synopsis of the content in the strata object, including total number of layers, thickness of the study section, and number of layers by lithology type. Once the stratigraphy data are loaded into R, and validated as a strata valid object, the users are able to explore stratigraphic information quantitatively (e.g., summarizing it by lithology type or grain size).

Usage

## S3 method for class 'strata'
summary(object, grain.size = FALSE, ...)

Arguments

object

an object of strata class for which a summary is desired. See strata class for details about the requirements of this object.

grain.size

default FALSE; a logical value indicating whether the data should be summarized by grain size.

...

additional arguments affecting the summary produced.

Value

When summary function is executed over a strata object using the default options, the returned values are summarized by lithology; they include (i) total number of layers, (ii) total thickness of the section or borehole, (iii) thickness of covered intervals, (iv) thickness of each lithology expressed in percentage, and (v) total number of layers by lithology type. When the grain.size argument is setting to TRUE, summary details by grain size are included in the results.

Author(s)

John Ortiz

Examples

data(saltarin_beds)
saltarin_val <- strata(saltarin_beds, datum="top")
summary(saltarin_val)
summary(saltarin_val, grain.size=TRUE)