From 96b3545bd6c0caabb66b208562d61f65c6e759e7 Mon Sep 17 00:00:00 2001 From: Matt Wilkins Date: Fri, 20 Sep 2024 11:07:15 -0500 Subject: [PATCH] remove manual usage declaration --- R/prep_static_ggspectro.R | 5 ----- man/prep_static_ggspectro.Rd | 33 +++++++++++++++++++++++++++++---- 2 files changed, 29 insertions(+), 9 deletions(-) diff --git a/R/prep_static_ggspectro.R b/R/prep_static_ggspectro.R index bf64c85..b1ae6e5 100644 --- a/R/prep_static_ggspectro.R +++ b/R/prep_static_ggspectro.R @@ -7,11 +7,6 @@ #' #' @aliases prepStaticSpec prepStaticGGspec #' -#' @usage prep_static_ggspectro(soundFile,destFolder,outFilename,savePNG=FALSE,colPal="inferno", -#' crop=NULL,bg=NULL,filter=NULL,xLim=NULL,yLim=c(0,10),plotLegend=FALSE,onlyPlotSpec=TRUE, -#' ampTrans=1,min_dB=-30,wl=512, ovlp=90,wn="blackman",specWidth=9,specHeight=3, -#' colbins=30,ampThresh=0,bgFlood=FALSE,fontAndAxisCol=NULL,optim=NULL,...) -#' #' @param soundFile should work with URLs, full and relative paths; handles .mp3 and .wav #' @param destFolder path to directory to save output. Needs to be like "figures/spectrograms/" to be relative to working directory. Default=parent folder of soundFile. Specify "wd" to output to the working directory, gotten from [get_wd()] #' @param outFilename name for output PNG. default=NULL will use input name in output filename. diff --git a/man/prep_static_ggspectro.Rd b/man/prep_static_ggspectro.Rd index f51f130..ac9f9dd 100644 --- a/man/prep_static_ggspectro.Rd +++ b/man/prep_static_ggspectro.Rd @@ -6,10 +6,35 @@ \alias{prepStaticGGspec} \title{Generate ggplot2-based spectrogram(s), which can be passed to paged_spectro} \usage{ -prep_static_ggspectro(soundFile,destFolder,outFilename,savePNG=FALSE,colPal="inferno", -crop=NULL,bg=NULL,filter=NULL,xLim=NULL,yLim=c(0,10),plotLegend=FALSE,onlyPlotSpec=TRUE, -ampTrans=1,min_dB=-30,wl=512, ovlp=90,wn="blackman",specWidth=9,specHeight=3, -colbins=30,ampThresh=0,bgFlood=FALSE,fontAndAxisCol=NULL,optim=NULL,...) +prep_static_ggspectro( + soundFile, + destFolder, + outFilename = NULL, + savePNG = FALSE, + colPal = "inferno", + crop = NULL, + bg = NULL, + filter = NULL, + xLim = NULL, + yLim = c(0, 10), + title = NULL, + plotLegend = FALSE, + onlyPlotSpec = TRUE, + ampTrans = 1, + resampleRate = 15000, + min_dB = -30, + wl = 512, + ovlp = 90, + wn = "blackman", + specWidth = 9, + specHeight = 3, + colbins = 30, + ampThresh = 0, + bgFlood = FALSE, + fontAndAxisCol = NULL, + optim = NULL, + ... +) } \arguments{ \item{soundFile}{should work with URLs, full and relative paths; handles .mp3 and .wav}