histyear: histyear plots a histogram of a variable for each year...

View source: R/datalow_utils.r

histyearR Documentation

histyear plots a histogram of a variable for each year available

Description

histyear plots a histogram of a variable for each year available.

Usage

histyear(
  x,
  Lbound = -3.5,
  Rbound = 12.25,
  inc = 0.25,
  new = FALSE,
  plots = c(11, 3),
  pickvar = "LnCE",
  varlabel = "log(CPUE)",
  col = 2,
  border = 2,
  addnormal = TRUE,
  right = TRUE,
  vline = "mean"
)

Arguments

x

the data.frame of data with at least a 'Year' and pickvar present

Lbound

leftbound on all histograms, defaults to -3.5

Rbound

right bound on all histograms, defaults to 12.25

inc

the class width of the histogram, defaults to 0.25

new

reuse a plotting device or output a new one

plots

the number of rows and columns, defaults to c(11,3)

pickvar

which variable in the input data.frame to plot each year default = 'LnCE'

varlabel

what label to use on x-axis, default = 'log(CPUE)'

col

colour of each cell; defaults to 2 (red)

border

colour of the border of each cell, default = 2 (red)

addnormal

include the fitting of a normal distribution

right

put the legend on the right hand side, default = TRUE

vline

allows for the placing of a vertical line on each histogram if set to "" then nothing is added. defaults to the average.

Value

a matrix of the year, mean value, stdev, and N number of observations. It also plots a histogram for each year and fits a normal distribution to each one.

Examples

## Not run: 
print("still to be developed")

## End(Not run)

haddonm/datalowSA documentation built on Nov. 5, 2023, 6:40 p.m.