analyse: Run audioBlast analyses

View source: R/analyse.R

analyseR Documentation

Run audioBlast analyses

Description

This is the main function for analysing recordings from audioBlast in the R environment.

Usage

analyse(
  db,
  db_legacy = FALSE,
  mode = "local",
  source = "unp",
  debug = FALSE,
  id = NULL,
  task = NULL,
  verbose = FALSE,
  force = FALSE,
  base_dir = "",
  retain = FALSE,
  sleep = NULL,
  save.path = "."
)

Arguments

db

database connector

db_legacy

If TRUE allows use with RMariaDB connectors that have issues with stored procedures

mode

"web" for online files, or "local" for local files

source

Specify source to analyse

debug

If TRUE and used with id and task then allows for debugging a single recording

id

Specify id of a file within source to analyse (only used with debug=T)

task

Specify a task (for use when debug=T)

verbose

Gives verbose output if TRUE

force

Forces recalculation of analyses if TRUE

base_dir

Directory relative paths are located in

retain

If TRUE will save web files to base_dir

sleep

Number of seconds to sleep after all jobs are complete before requesting additional work from the database. Default (NULL) cancels the task.

save.path

Path to save data


audioblast/audioBlastAnalyse documentation built on Jan. 20, 2024, 2:36 a.m.