createSettings: Create settings file (csv) or data frame by defining the...
In mabecker89/solo: A Set of Tools for Sound Localization

createSettings

R Documentation

Create settings file (csv) or data frame by defining the localization settings.

Description

createSettings takes a series of arguments and creates a data frame (or csv) with standard structure that can be read by other functions in the locaR package.

Usage

createSettings(
  projectName,
  run = 1,
  detectionsFile,
  coordinatesFile,
  siteWavsFolder,
  adjustmentsFile,
  channelsFile,
  date,
  time,
  tempC = 15,
  soundSpeed,
  surveyLength,
  margin = 10,
  zMin = -1,
  zMax = 10,
  resolution = 1,
  buffer = 0.2,
  write.csv = FALSE
)

Arguments

`projectName`	Character. A string specifying the name of a project.
`run`	Numeric. Within each survey, start with run = 1, then count upwards. So, run 2 would be used to re-localize sounds that were poorly localized in run 1, etc. Running them again with slightly different settings (e.g. start/end times or low/high frequencies) can improve results.
`detectionsFile`	Character. File path to the detections file (csv).
`coordinatesFile`	Character. File path to the coordinates file (csv).
`siteWavsFolder`	Character. Folder path of the directory containing audio files. The folder path will be searched recursively if using `localizeSingle` or `localizeMultiple`.
`adjustmentsFile`	Character. File path to the adjustments file (csv). Not required to be specified.
`channelsFile`	Character. File path to the channels file (csv), specifying which channel (1 or 2) to use for each recording unit.
`date`	Numeric. Eight digit number representing a date in the format YYYYMMDD.
`time`	Numeric. Five or six digit number representing the start time of a recording session (90000 = 09:00:00, and 160000 = 16:00:00).
`tempC`	Numeric. Temperature in degrees C, which is used to calculate the speed of sound in air using the equation 331.45*sqrt(1+tempC/273.15).
`soundSpeed`	Numeric. The speed of sound in meters per second. If missing, the speed of sound is calculated based on the specified temperature (assuming the transmission medium is air). If soundSpeed is specified, the tempC value is over-ridden.
`surveyLength`	Numeric. Length of the survey, in seconds.
`margin`	distance (in meters) to extend the search grid beyond the x-y limits of the microphone locations. The same buffer is applied to x and y coordinates.
`zMin`	distance (in meters) to begin grid search relative to the microphone with the lowest elevation. Typically a small negative number to ensure that the grid search begins slightly below the lowest microphone.
`zMax`	distance (in meters) to end search relative to the microphone with the highest elevation. Typically a positive number to ensure that the grid search ends well above the highest microphone.
`resolution`	resolution of the search map, in meters.
`buffer`	Amount of time (in seconds) to expand each detection. This accounts for imprecise time boundaries, and also the differences imposed by time delays between different microphones (e.g. two microphones separated by some amount will receive the same sound at different times).
`write.csv`	Logical. Whether or not to write a settingsFile csv. The csv will be written to the same directory as the detections file.