burnr (version 0.4.0)

sort.fhx: Sort the series names of fhx object by the earliest or latest year.

Description

Sort the series names of fhx object by the earliest or latest year.

Usage

# S3 method for fhx
sort(x, decreasing = FALSE, sort_by = "first_year", ...)

Arguments

x

An fhx instance to be sorted.

decreasing

Logical. Decreasing sorting? Defaults to FALSE.

sort_by

Either 'first_year' or 'last_year'. Designates the inner or outer year for sorting. Defaults to 'first_year'

...

Additional arguments that fall off the face of the universe.

Value

A copy of x with reordered series.

Examples

# NOT RUN {
data(lgr2)
plot(sort(lgr2, decreasing = TRUE))
plot(sort(lgr2, sort_by = "last_year"))

# }