lxy.plot.freq: Plots of sampling frequency

Description Usage Arguments Value Note See Also

Description

Creates plots of the temporal extent and sampling frequency of a LoCoH-xy object

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
lxy.plot.freq(lxy, id = NULL, deltat.by.date = F, samp.by.date = F,
  cp = F, cp.min = 0, cp.max = 1, time.unit = c("auto", "sec",
  "min", "hour", "day", "week", "month", "year")[1], xlim = NULL,
  ylim = NULL, ylim.deltat.by.date = c(0, 0.999), sbd.y.jiggle = 0.1,
  sbd.vline = NULL, sbd.vline.trunc.units.to = c("secs", "mins",
  "hours", "days")[4], cex.pts = 0.3, desc = c(0, 1, 3)[2],
  cex.desc = 0.8, col.desc = "darkgreen", title = NULL,
  title.show = TRUE, subtitle = "auto", mar = c(2.8, 2.8, if
  (title.show) 2.8 else 0.5, 0.5), mgp = c(1.8, 0.5, 0),
  figs.per.page = NULL, status = TRUE, panel.num = NULL,
  panel.num.inside.plot = !title.show, png.dir = NULL,
  png.dir.make = TRUE, png.width = 800, png.height = png.width,
  png.overwrite = TRUE, png.pointsize = 12 + (png.width - 480)/80, ...)

Arguments

lxy

A LoCoH-xy object

id

The id(s) of the individual(s) to include in the plot

deltat.by.date

Produce a plot of the sampling interval by date. T/F

samp.by.date

Produce a scatterplot showing the number of samples by date. T/F

cp

Produce a plot of the cummulative proportion of sampling frequencies. T/F

cp.min

The minimum sampling frequency (expressed as a proportion of tau) shown on the plot

cp.max

The maximum sampling frequency (expressed as a proportion of tau) shown on the plot

time.unit

A unit of time that will be used on the y-axis when plotting frequency by date

xlim

The range for the x-axis. Can be a two-element vector (min, max), NULL (range will be computed from the data), or "same" (same range will be used for all individuals).

ylim

The range for the y-axis.

ylim.deltat.by.date

A two-element numeric vector with values 0..1. Will interpret these values as the first and last percentiles of delta.t to plot

sbd.y.jiggle

An amount to 'jiggle' the y values to better see point density

sbd.vline

An interval of time (in seconds) for which vertical lines will be included on the sampling interval by date plot, to help see the dates

sbd.vline.trunc.units.to

A character "secs", "mins", "hours" or "days" specifying where to draw the first vertical lines. quantiles of delta.t when setting the range of ylim when deltat.by.date=TRUE

cex.pts

The expansion factor for points on the plot

desc

Which side to display automatically generated desciptive text (e.g. caption). 0=none, 1=bottom, 3=top.

cex.desc

The expansion factor for the descriptive text. Numeric value.

col.desc

The color of the descriptive text. Color value.

title

The title to be displayed. Character. If NULL a title will be constructed.

title.show

Whether to show the title. T/F

subtitle

The plot subtitle. If 'auto' a default subtitle will be used, or pass an empty string '' to omit. Character

mar

The plot margins. A four item numeric vector

mgp

The distance away from the edge of the plot for the 1) label, 2) tick marks, and 3) axis line. A three-item numeric vector

figs.per.page

The number of plots per page.

status

Show status messages. T/F

panel.num

A number or letter to display in the upper left hand corner of the plot when the plot will be used as part of a multi-frame graphic (as in publications). Character

panel.num.inside.plot

Whether to display panel.num inside the plot area itself, as opposed to the title area. T/F

png.dir

The directory for a PNG file (filename will be constructed automatically). Ignored if png.fn is passed

png.dir.make

Whether to create png.dir if it doesn't exist. T/F

png.width

The width of the PNG image

png.height

The height of the PNG image

png.overwrite

Whether to overwrite an existing PNG file if it exists. T/F

png.pointsize

The pointsize (in pixels) for the PNG image, equivalent to the height or width of a character in pixels (increase to make labels appear larger)

...

Additional parameters that will be passed to the plot function

Value

A list of lists, one for each plot containing the filename (NULL if no png made), the image dimensions (NULL), descriptive text, and id

Note

Plotting the cummulative percentage of sampling frequencies (codecp=TRUE) can help determine a threshhold below which pairs of points should be considered to be part of the same 'burst' (see lxy.thin.bursts). For example, if most points are sampled 1 hour apart, but there are a few bursts of points that were only 2 minutes apart, the cumuulative percentage of sampling frequencies will reveal a cluster of sampling intervals around 2 minutes and the majority around 1 hour.

Plotting the sampling frequency over time can help identify gaps in the data as well as frequencies for harmonising sampling frequency

See Also

lxy.thin.bursts, lxy.thin.byfreq


tlocoh documentation built on May 2, 2019, 5:27 p.m.