getCycles: getCycles

getCyclesR Documentation

getCycles

Description

Gets the cycles data.frame from one or more NPSForVeg objects.

Usage

getCycles(object, cycles = NA, years = NA)

Arguments

object

Either a data.frame like that stored in the Cycles slot, an NPSForVeg object or a list of such objects.

cycles

A vector of cycle codes. Will only return data from those cycles.

years

A length 1 numeric vector containing one or more years. Will only return cycles that include those years.

Details

When the "object" is a data.frame or a single NPSForVeg object this function will return the data.frame in the "Cycles" slot. This data.frame will be filtered as specified in the other arguments. When "object" is a list then a list is returned. Each element of the list will be the filtered data.frame from "Cycles" slot from the input NPForVeg objects.

Value

Either a data.frame or a list containing the contents of the "Cycles" slot for one or more NPSForVeg objects.


NCRN/NPSForVeg documentation built on March 26, 2024, 7:13 a.m.