processSettings: Process settings file to extract relevant information.

In mabecker89/solo: A Set of Tools for Sound Localization

Process settings file to extract relevant information.

Description

processSettings reads information from a settings file (csv) and combines them into a list for subsequent localization.

Usage

processSettings(settingsFile, settings, getFilepaths = FALSE, types = "wav")

Arguments

settingsFile	Filepath to the settings file (csv).
settings	data.frame created either by reading a settings file (csv) or using the createSettings function. Not needed if settingsFile is specified.
getFilepaths	Logical, indicating whether to add filepath information using getFilepaths.
types	Character. If getFilepaths is TRUE, which types of files to look for ('wav' or 'mp3').

Value

A list with information needed for sound localization, including microphone coordinates, the existing detections, channels to use for each recording unit, and information specifying the size and resolution of the grid within which to localize sound sources.

Examples

    #Read example data
    settings <- read.csv(system.file('extdata', 'Ex_20200617_090000_Settings.csv',
                                     package = 'locaR'), stringsAsFactors = FALSE)

    #Over-write default values for SiteWavsFolder, CoordinatesFile, and ChannelsFile
    settings$Value[settings$Setting == 'SiteWavsFolder'] <-
                   system.file('extdata', package = 'locaR')
    settings$Value[settings$Setting == 'CoordinatesFile'] <-
                   system.file('extdata', 'Vignette_Coordinates.csv', package = 'locaR')
    settings$Value[settings$Setting == 'ChannelsFile'] <-
                   system.file('extdata', 'Vignette_Channels.csv', package = 'locaR')

    #Run processSettings() function
    st <- processSettings(settings = settings, getFilepaths = FALSE)

mabecker89/solo documentation built on March 1, 2023, 10:14 a.m.