Skip to contents

Summary Method for gfc_basin_trajectories Objects

Source: R/gfc_flow.R
summary.gfc_basin_trajectories.Rd

Summary Method for gfc_basin_trajectories Objects

Usage

# S3 method for class 'gfc_basin_trajectories'
summary(
  object,
  ...,
  length.quantiles = c(0, 0.25, 0.5, 0.75, 1),
  max.show = 10L
)

Arguments

object

A gfc_basin_trajectories object returned by basin.trajectories.gfc.flow().

...

Additional arguments (ignored).

length.quantiles

Numeric vector of quantiles to report for trajectory lengths.

max.show

Integer. Number of example trajectories (by id) to show in the summary.

Value

A list of class summary.gfc_basin_trajectories.