getPlotNames: getPlotNames

getPlotNamesR Documentation

getPlotNames

Description

Returns the names of plots from an NPSForVeg object that meet various criteria.

Usage

getPlotNames(
  object,
  type = "active",
  visits = NA,
  years = NA,
  subparks = NA,
  output = "vector",
  ...
)

Arguments

object

An NPSForVeg object or a list of such objects.

type

One of three options indicating the type of plots to be considered. Must be in quotes. Options are:

"active"

The default. Only returns data for plots which are listed as active in the Plots$Location_Status field.

"all"

The default. retruns data from all types of plots.

"retired"

Only returns data from plots which are listed as retired in the Plots$Location_Status field.

visits

A numeric vector. Returns only data from plots where the number of plot visits matches one of the values in visits The number of visits to a plot is determined by the Event_Count column in the Events slot.

years

A numeric vector. Returns only plot data from plots where the years the plot was visited matches one of the values in years. The year a visit takes place is determined by the Event_Year column in the Events slot.

subparks

A character vector. Returns only data from plots where the subpark the plot is in matches one of the values in subparks. The subpark a plot is located in is determined by the SubUnit_Code column in the Plots slot.

output

Either "vector" (the default) or "list". Note that this must be in qutoes. Determines the type of output from the function

...

Other arguments that are passed on to getPlots.

Details

This function is a wrapper for getPlots()$Plot_Name. It first calls getPlots and then extracts the Plot_Name field. It is meant as a convenience function.


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