SpecPlotter: Field Data Visualization Function

In huntercole25/StellarHelper: A Companion to StellarNet Spectroradiometers

Description

This function creates a dark-themed plot for quickly visualizing spectral data while maintaining the integrity of your scoptopic vision.

Usage

SpecPlotter(
  FilePath,
  Lims = c(250, 1100),
  ObjectSave = T,
  ObjectName = paste0(Filename, "_spec"),
  BreakInt = 50,
  Vgrid = F,
  Title = basename(FilePath),
  Ylab = "Count",
  SavePlot = F
)

Arguments

FilePath	A character string providing the full file path to the spectral file of interest including file extension.
Lims	A numeric vector indicating the wavelength limits to be read in via 'pavo::getspec()'. This vector cannot go outside of the wavelengths in the file of interest. Defaults to c(250, 1100).
ObjectSave	A Boolean value indicating whether the spectral data should be saved as an object in the global environment. Defaults to T.
ObjectName	A character string indicating the name of the rspec object that is saved to the global environment if 'ObjectSave = T'.
BreakInt	An integer inidcating the x-axis label interval in nanometers. Defaults to 50.
Vgrid	A Boolean value indicating whether the major grid lines should be visible. Defaults to F.
Title	A character string providing the desired plot title. Defaults to the file name.
Ylab	A character string providing the desired y-axis label. Defaults to "Count" which is appropriate for data collected in scope mode.
SavePlot	A Boolean value indicating whether the plot this function generates should be saved as a .png file in the same directory and with the same name as the spectral file. Defaults to F.

Examples

##Not run:
#Plotting a .SSM file
SpecPlotter("~/Documents/example_file.ssm")

#Plotting a .IRR file from 500nm-700nm
SpecPlotter("~/Documents/example_file.IRR", Lims = c(500,700))

huntercole25/StellarHelper documentation built on March 22, 2020, 1:14 a.m.