import_GUANO: Read GUANO Metadata From WAV Files

View source: R/new_importer.R

import_GUANOR Documentation

Read GUANO Metadata From WAV Files

Description

import_GUANO reads GUANO metadata stored in WAV files generated through bat acoustic monitoring and saves them as a data.frame in an RData file for easy reference. This function can generate a new RData file, add GUANO from new files to an existing RData file, or update metadata in an existing RData file where the metadata of the original files has changed.

Usage

import_GUANO(
  action,
  input_path,
  site_col,
  timezone,
  data_path = NULL,
  fast_import = F
)

Arguments

action

Character. Must equal "New", "Add" or "Update". Use "New" to read GUANO from a new set of files and create a fresh RData file. Use "Add" to add GUANO from a new set of files to an existing RData file that already contains other data. Use "Update" to update an existing RData files from WAV that have been previously imported and then had their GUANO metadata changed.

input_path

Character. Path to the directory containing the files you wish to read the metadata from. Note that sub-directories are also read.

site_col

Character. Name of the GUANO metadata field specifying the recording location / site name.

data_path

Character. Path to an existing RData file. Optional when "New" action is specified (a location will be requested before data are read and saved). Required when "Add" or "Update" actions are specified.

fast_import

Option to increase import speed (experimental).

Value

An RData file saved in a specified location containing GUANO metadata read from WAV files created through bat acoustic monitoring.

Note

This function will take a long time for large data sets. Folders containing tens of thousands of files may take several hours to read! For this reason it is recommended to complete all manual vetting before proceeding. However, files with changed metadata can be updated later using the "Update" action.

See Also

Other Import Functions: GUANO_loader(), GUANO_reader(), log_file_parser()

Other import tools: import_logs()

Examples

## Not run: #' import_GUANO("New", "C:/Folder/Folder/WAVs_Folder", "Location", "C:/Folder/Folder/Data.RData")

vulpes-vulpes/batr documentation built on Jan. 23, 2025, 3:23 p.m.