BCIPlot: BCIPlot

BCIPlotR Documentation

BCIPlot

Description

Plots BCI score over time.

Usage

BCIPlot(
  object,
  years = NA,
  points = NA,
  visits = NA,
  times = NA,
  plot_title = NA,
  point_num = NA,
  type = "Cent_Appal",
  caption = T,
  palette = "BuGn",
  output = "total",
  plot = TRUE,
  ...
)

Arguments

object

An NCRNbirds object a list of such objects, or a data.frame like that produced by birdRichness().

years

A numeric vector. Indicates which years should be graphed.

points

A character vector of point names. Only these points will be used.

visits

A length 1 numeric vector, defaults to NA. Returns data only from the indicated visits.

times

A numeric vector of length 1. Returns only data from points where the number of years that a point has been vistied is greater or equal to the value of times. This is determined based on the data found in the Visits slot.

plot_title

Optional, A title for the plot.

point_num

An optional numeric vector indicating the number of points sampled each year. If object is a NCRNbirds object then this will be calculated automatically. If object is a data.frame or a list than this can be provided by the user.

type

A mandatory length 1 character vector that indicates the type of BCI to calculate. Can be "Cent_Appal" (default) or "NETN_Forest_BCI"

caption

Logcial. Indicates if the default caption "Values in parentheses indicate the number of points monitored each visit of each year." should be included.

palette

Color pallete for the background of the graph. Defaults to "BuGn" (blue green) but will accept any RColorBrewer palette

output

Either "total" (the default) or "list". Only used when object is a list.

plot

Logical. Return plot TRUE (default) or data.frame FALSE.

...

Additional arguments passed to birdRichness

Details

This function produces a graph the Bird community Index over time. It does this by using the output of the BCI function, and averging the plot values for the park's yearly value. The error bars on the plot reprsent 95 bootstrap confidence intervals. The data is then passed on to ggplot2 for graphing. Typically this is done automatically by providing an NCRNbirds object or a list of such objects. If the user wishes to provide their own data.frame it should have 3 columns, Year, BCI, BCI_Category and each row should be data from single year.


NCRN/NCRNbirds documentation built on Aug. 28, 2023, 12:12 p.m.