dot-roxygen_defaults: Canonical roxygen docs (inherited, not user-facing)

In soundgen: Sound Synthesis and Acoustic Analysis

Canonical roxygen docs (inherited, not user-facing)

Description

Canonical roxygen docs (inherited, not user-facing)

Usage

.roxygen_defaults(
  x,
  samplingRate,
  scale,
  from,
  to,
  windowLength,
  step,
  overlap,
  wn,
  zp,
  dynamicRange,
  play,
  saveAudio,
  plot,
  savePlots,
  embed,
  reportEvery,
  cores,
  width,
  height,
  units,
  res,
  normalize
)

Arguments

x	path to a folder, one or more wav or mp3 files c('file1.wav', 'file2.mp3'), Wave object, numeric vector, or a list of Wave objects or numeric vectors
samplingRate	sampling rate of x (only needed if x is a numeric vector)
scale	maximum possible amplitude of input, used to normalize the input vector (only needed if x is a numeric vector)
from, to	if NULL (default), analyzes the whole sound, otherwise from...to (s)
windowLength	length of the analysis window, ms
step	step between successive windows, ms; if provided, overrides overlap; because digital audio is sampled at discrete time intervals of 1/samplingRate, the actual step and thus the time stamps of STFT frames may be slightly different - e.g., 24.98866 instead of 25.0 ms
overlap	overlap between successive windows, %
wn	window type accepted by winFun: character string or function
zp	window length after zero padding, samples. No padding is performed if zp < analysis window length in samples. If NULL, the signal is padded to a good number for speeding up the FFT
dynamicRange	regions under -dynamicRange dB are treated as silent
play	if TRUE, plays the output audio using the default player on your system. If a character string, it is passed to playme as the name of the player to use (e.g. 'aplay', 'play', 'vlc'). In case of errors, try setting another default player for playme
saveAudio	if TRUE, saves the processed audio in a subdirectory named after the function and created in the input directory (if input is a file or folder) or in the working directory
plot	if TRUE, produces a plot of the results
savePlots	if TRUE, creates a subdirectory in the input directory (if input is a file or folder) or in the working directory (if input is a vector etc), named after the function (eg "spectrogram/"). All plots and audio files (if any) are saved in this new directory. If there are multiple inputs, an html notebook is also created for easy viewing and listening
embed	if TRUE and savePlots is set and there are multiple inputs, all saved images and audio (if any) are embedded in the exported html notebook for easy sharing; if FALSE, the html file links to separate images and audio files (but separate files are still saved). NB: for this to work, package "base64enc" must be installed
reportEvery	when processing multiple inputs, report estimated time left every reportEvery iterations (NULL = default, NA = don't report); see reportTime
cores	number of cores for parallel processing
width, height, units, res	graphical parameters for saving plots passed to png
normalize	"orig" = same as input (default), "max" = maximum possible peak amplitude for the given input scale, "none" = no normalization

soundgen documentation built on Sept. 20, 2026, 5:07 p.m.