From b57596889df92920f96f905920b9333b4ec711a2 Mon Sep 17 00:00:00 2001 From: edwbaker Date: Wed, 30 Oct 2024 18:08:49 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20edwbaker?= =?UTF-8?q?/SonicScrewdriveR@d75587939d2b784c9ca37ec257da96805e9d95a4=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dev/pkgdown.yml | 2 +- dev/reference/dot-merge_annotations.html | 101 +++++++++++++++++++++++ dev/reference/index.html | 16 ++-- dev/reference/merge_annotations.html | 100 ++++++++++++++++++++++ dev/search.json | 2 +- dev/sitemap.xml | 4 +- 6 files changed, 213 insertions(+), 12 deletions(-) create mode 100644 dev/reference/dot-merge_annotations.html create mode 100644 dev/reference/merge_annotations.html diff --git a/dev/pkgdown.yml b/dev/pkgdown.yml index ec27780..06a5ab1 100644 --- a/dev/pkgdown.yml +++ b/dev/pkgdown.yml @@ -9,7 +9,7 @@ articles: articles/other-apps: other-apps.html sonicscrewdriver: sonicscrewdriver.html articles/test-signals: test-signals.html -last_built: 2024-10-30T11:25Z +last_built: 2024-10-30T18:06Z urls: reference: https://sonicscrewdriver.ebaker.me.uk/reference article: https://sonicscrewdriver.ebaker.me.uk/articles diff --git a/dev/reference/dot-merge_annotations.html b/dev/reference/dot-merge_annotations.html new file mode 100644 index 0000000..637de72 --- /dev/null +++ b/dev/reference/dot-merge_annotations.html @@ -0,0 +1,101 @@ + +Combine annotations helper function — .merge_annotations • sonicscrewdriver + Skip to contents + + +
+
+
+

Combine annotations helper function

+ Source: R/Annotation.R +
dot-merge_annotations.Rd
+
+ +
+

Checks a list of annotations for those that are overlapping in the time or +frequency domain, and returns a list where overlapping annotations are merged.

+
+ +
+

Usage

+ 
.merge_annotations(annotations, domain = "time", same.source = TRUE)
+
+ +
+

Arguments

+ + +
annotations
+

A list of Annotation objects.

+ + +
domain
+

Domain of the annotations, either "time" or "frequency".

+ + +
same.source
+

If TRUE, annotations must have the same source to be merged.

+ +
+
+

Value

+

A list of Annotation objects.

+
+
+

Details

+

The exported function merge_annotations() handles sanity checks and calls this function.

+
+ +
+ + +
+ + + + + + + diff --git a/dev/reference/index.html b/dev/reference/index.html index 73039c5..5a63c56 100644 --- a/dev/reference/index.html +++ b/dev/reference/index.html @@ -131,12 +131,6 @@

All functionsannotations_merge() - - -
Combine annotations
-
- audio_filesize()
@@ -365,10 +359,10 @@

All functions.annotation_merge_overlapping() + .merge_annotations() -
Combine overlapping annotations
+
Combine annotations helper function

.spectrogram_maad_power() @@ -557,6 +551,12 @@

All functionsmerge_annotations() + +

+
Combine annotations
+
+ naturalFrequency()
diff --git a/dev/reference/merge_annotations.html b/dev/reference/merge_annotations.html new file mode 100644 index 0000000..b86cc03 --- /dev/null +++ b/dev/reference/merge_annotations.html @@ -0,0 +1,100 @@ + +Combine annotations — merge_annotations • sonicscrewdriver + Skip to contents + + +
+
+
+

Combine annotations

+ Source: R/Annotation.R +
merge_annotations.Rd
+
+ +
+

Checks a list of annotations for those that are overlapping in the time or +frequency domain, and returns a list where overlapping annotations are merged. +Annotation objects must have the same file, type and value to be merged.

+
+ +
+

Usage

+ 
merge_annotations(annotations, domain = "time", same.source = TRUE)
+
+ +
+

Arguments

+ + +
annotations
+

A list of Annotation objects.

+ + +
domain
+

Domain of the annotations, either "time" or "frequency".

+ + +
same.source
+

If TRUE, annotations must have the same source to be merged.

+ +
+
+

Value

+

A list of Annotation objects.

+
+ +
+ + +
+ + + + + + + diff --git a/dev/search.json b/dev/search.json index 5a27c39..06dbf6e 100644 --- a/dev/search.json +++ b/dev/search.json @@ -1 +1 @@ -[{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/CODE-OF-CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"interest fostering open welcoming environment, contributors maintainers pledge making participation project community harassment-free experience everyone, regardless age, body size, disability, ethnicity, gender identity expression, level experience, nationality, personal appearance, race, religion, sexual identity orientation.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/CODE-OF-CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes creating positive environment include: Using welcoming inclusive language respectful differing viewpoints experiences Gracefully accepting constructive criticism Focusing best community Showing empathy towards community members Examples unacceptable behavior participants include: use sexualized language imagery unwelcome sexual attention advances Trolling, insulting/derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical electronic address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/CODE-OF-CONDUCT.html","id":"our-responsibilities","dir":"","previous_headings":"","what":"Our Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Project maintainers responsible clarifying standards acceptable behavior expected take appropriate fair corrective action response instances unacceptable behavior. Project maintainers right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, ban temporarily permanently contributor behaviors deem inappropriate, threatening, offensive, harmful.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/CODE-OF-CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within project spaces public spaces individual representing project community. Examples representing project community include using official project e-mail address, posting via official social media account, acting appointed representative online offline event. Representation project may defined clarified project maintainers.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/CODE-OF-CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported contacting project team edwbaker@gmail.com. project team review investigate complaints, respond way deems appropriate circumstances. project team obligated maintain confidentiality regard reporter incident. details specific enforcement policies may posted separately. Project maintainers follow enforce Code Conduct good faith may face temporary permanent repercussions determined members project’s leadership.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/CODE-OF-CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 1.4, available http://contributor-covenant.org/version/1/4","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/audioblast.html","id":"what-is-audioblast","dir":"Articles","previous_headings":"","what":"What is audioblast?","title":"Using audioBlast with R","text":"Audioblast discovery tool bioacoustic ecoacoustic recordings. can use search recordings (e.g. species, location, date), annotations recordings, analysis results traits. Audioblast currently hosted Natural History Museum London. conceived Ed Baker University York part Leverhulme Trust funded Automated Acoustic Observatories project.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/audioblast.html","id":"accessing-audioblast","dir":"Articles","previous_headings":"","what":"Accessing audioblast","title":"Using audioBlast with R","text":"audioblast() function SonicScrewdriveR wrapper allowing full access Audioblast API. also possible download many recordings audioblast using audioblastDownload().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/augment-audio-data.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Augmenting audio data in R with SonicScrewdriveR","text":"Augmenting data common practice machine learning. process creating new data existing data (e.g. adding noise). done increase size training data make model robust. article show augment audio data R using sonicscrewdriver package. generateX() functions sonicscrewdriver designed operate Wave-like objects (Wave WaveMC tuneR Tagged equivalents) list Wave-like objects. Similarly, functions return list Wave-like objects. means can chain functions together create complex data augmentation pipelines.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/augment-audio-data.html","id":"types-of-augmentation","dir":"Articles","previous_headings":"","what":"Types of augmentation","title":"Augmenting audio data in R with SonicScrewdriveR","text":"order demonstrate data augmentation process, use sonicscrewdriver package generate Dirac pulse.","code":"# Generate a Dirac pulse p <- pulse(\"dirac\") # Plot the pulse seewave::oscillo(p)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/augment-audio-data.html","id":"noise-augmentation","dir":"Articles","previous_headings":"Types of augmentation","what":"Noise augmentation","title":"Augmenting audio data in R with SonicScrewdriveR","text":"Noise augmentation common technique used increase size training data. process adding noise original data. sonicscrewdriver package provides generateNoise() function add noise audio data. example add two different amounts white noise Dirac pulse.","code":"augmented <- c( generateNoise(p, \"white\", noise.ratio=0.1), generateNoise(p, \"white\", noise.ratio=0.3) ) for (i in 1:length(augmented)) { seewave::oscillo(augmented[[i]]) }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/augment-audio-data.html","id":"time-shifting-rotationpadding","dir":"Articles","previous_headings":"Types of augmentation","what":"Time shifting (rotation/padding)","title":"Augmenting audio data in R with SonicScrewdriveR","text":"Time shifting process shifting audio data certain number samples. sonicscrewdriver package provides generateTimeShift() function rotate audio data, either rotating audio data within file, padding file silence. demonstrate time shifting generate sum sine wave Dirac pulse. Time shifting inserting silence. Alternatively, can rotate audio data.","code":"p1 <- tuneR::sine(440, duration=44100*3) p2 <- pulse(\"dirac\", duration=44100*3) p <- 0.25*p1 + normalise(p2) seewave::oscillo(p) # Rotate the audio data by one second rotated <- generateTimeShift(p, amount=1) seewave::oscillo(rotated[[1]]) # Rotate the audio data by one second rotated <- generateTimeShift(p, type=\"rotate\", amount=1) seewave::oscillo(rotated[[1]])"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/augment-audio-data.html","id":"time-masking","dir":"Articles","previous_headings":"","what":"Time-masking","title":"Augmenting audio data in R with SonicScrewdriveR","text":"Time-masking process zeroing section audio data. sonicscrewdriver package provides generateTimeMask() function mask section audio data. demonstrate time masking first generate sine wave. Random masking sets random section audio data zero. example use duty cycle 0.95, means 5% audio data set zero. also possible introduce masking using square wave. n.periods parameter controls number periods square wave, dutyCycle parameter controls duty cycle square wave.","code":"# Generate a sine wave w <- tuneR::sine(1000, duration=100) # Plot the left audio channel plot(w@left) # Mask the audio data masked <- generateTimeMask(w, method=\"random\", dutyCycle=0.95) plot(masked@left) # Mask the audio data masked <- generateTimeMask(w, method=\"squarewave\", dutyCycle=0.5, n.periods=5) plot(masked@left)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/augment-audio-data.html","id":"combining-augmentations","dir":"Articles","previous_headings":"","what":"Combining augmentations","title":"Augmenting audio data in R with SonicScrewdriveR","text":"sonicscrewdriver package allows chain together multiple augmentations create complex data augmentation pipelines. example, can add noise audio data rotate audio data. possible use anonymous functions add multiple augmentations single step. can effectively used generate large amounts augmented data. code generates three different noise augmented versions input, two different time-shifted versions , yielding six augmented versions. approach can used list initial Wave-like objects.","code":"# Load some test audio data f <- system.file(\"extdata\", \"AUDIOMOTH.flac\", package=\"sonicscrewdriver\") w <- readAudio(f) # Add noise to the audio data and then rotate the audio data using pipes augmented <- w |> generateNoise(\"white\", noise.ratio=0.1) |> generateTimeShift(amount=1) # Create list of data and augmentations data <- c(w, augmented) # Load some test audio data f <- system.file(\"extdata\", \"AUDIOMOTH.flac\", package=\"sonicscrewdriver\") w <- readAudio(f) # Add noise to the audio data and then rotate the audio data using pipes augmented <- w |> {\\(x) c(generateNoise(x, \"white\", noise.ratio=0.1), generateNoise(x, \"white\", noise.ratio=0.3), generateNoise(x, \"white\", noise.ratio=0.5)) }() |> {\\(x) c(generateTimeShift(x, amount=1), generateTimeShift(x, amount=2)) }() # Create list of data and augmentations data <- c(w, augmented) # Load some test audio data f <- system.file(\"extdata\", \"AUDIOMOTH.flac\", package=\"sonicscrewdriver\") w <- list( readAudio(f), readAudio(f), readAudio(f) ) # Add noise to the audio data and then rotate the audio data using pipes and anonymous functions augmented <- w |> {\\(x) c(generateNoise(x, \"white\", noise.ratio=0.1), generateNoise(x, \"white\", noise.ratio=0.3), generateNoise(x, \"white\", noise.ratio=0.5)) }() |> {\\(x) c(generateTimeShift(x, amount=1), generateTimeShift(x, amount=2)) }() # Create list of data and augmentations data <- c(w, augmented)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/converting-code.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Converting code to work with SonicScrewdriveR","text":"SonicScrewdriveR introduces several tools working audio data, TaggedWave TaggedWaveMC formats. Inside SonicScrewdriveR Tagged non-Tagged versions Wave-like objects can used interchangeably, however necessarily true functions packages. guide aimed end users package developers want convert code work SonicScrewdriveR.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/converting-code.html","id":"taggedwave-and-taggedwavemc","dir":"Articles","previous_headings":"Introduction","what":"TaggedWave and TaggedWaveMC","title":"Converting code to work with SonicScrewdriveR","text":"try use function expects Wave object TaggedWave object, get error. end user can use untagWave function convert TaggedWave object Wave object. untagWave function can also used ‘untag’ TaggedWaveMC object. fix function package can make use inherits() rather alternative methods. TaggedWave inherits Wave can treated like Wave code. technique can used TaggedWaveMC objects inherits(w, \"WaveMC\").","code":"# Generate a `Wave` and `TaggedWave` sine w <- tuneR::sine(440) tw <- tagWave(w) # This will fail seewave::oscillo(tw) #> Error in seewave::oscillo(tw): argument \"f\" is missing, with no default # This will work seewave::oscillo(untagWave(tw)) # Methods that fail is(w, \"Wave\") class(w) == \"Wave\" # Method that works inherits(w, \"Wave\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/converting-code.html","id":"adding-a-process-to-a-tagged-wave-like-object","dir":"Articles","previous_headings":"Introduction > TaggedWave and TaggedWaveMC","what":"Adding a process to a Tagged Wave-like object","title":"Converting code to work with SonicScrewdriveR","text":"want add process TaggedWave object can use addProcess method. can either called end user, functions aware Tagged versions.","code":"# End user using non-Tagged aware function seewave::oscillo(untag(tw)) addProcess(tw, \"seewave::oscillo\") # Inside a Tagged aware function addProcess( tw, process = \"mypkg::functionToCountChannels\", output = list(channels = 2) )"},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/manage_audio.html","id":"reading-audio-files","dir":"Articles","previous_headings":"Managing audio in R with SonicScrewdriveR","what":"Reading audio files","title":"Managing audio in R","text":"Several functions available read audio files R, including readWave() readMP3() functions tuneR package, well tools package av. SonicScrewdriveR simplifies reading audio files providing single wrapper functions, readAudio(), can read audio files variety formats, including WAV, MP3, FLAC.","code":"filename <- system.file(\"extdata\", \"AUDIOMOTH.WAV\", package=\"sonicscrewdriver\") w <- readAudio(filename)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/manage_audio.html","id":"performing-analyses-on-channels","dir":"Articles","previous_headings":"Managing audio in R with SonicScrewdriveR","what":"Performing analyses on channels","title":"Managing audio in R","text":"existing functions operate single channel time. may cause unnecessarily complex workflows bulk analysing files different numbers channels. allChannels() function applies function channel returns list analyses. technique allows analysis performed channel, without reference number channels audio file. Optionally, cluster can specified process channels separate processor cores increase analysis speed.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/manage_audio.html","id":"windowing","dir":"Articles","previous_headings":"Managing audio in R with SonicScrewdriveR","what":"Windowing","title":"Managing audio in R","text":"often desirable process long audio file chunks. windowing() function can used split audio file overlapping non-overlapping windows. function may particularly useful processing long Wave files memory-efficient manner. Optionally, cluster can specified process windows separate processor cores increase processing speed. order demonstrate windowing() first define simple function draws rectangle around windowed region sound file. can show windows generated window.length 44100 samples, window.overlap 0. entire audio file analysed chunks 44100 samples, overlap windows. drawWindow() function applied window, result plotted top oscillogram original audio file. window.overlap parameter can adjusted windows overlap certain number samples. Alternatively, negative value window.overlap can used take regularly-spaced samples audio file. bind.wave parameter can used combine results windowing function single Wave object (FUN returns Wave object). example use windowing() add noise sections sine wave.","code":"drawWindow <- function( wave, start, window.length) { rect(start, -1, start+window.length, 1, col= rgb(0,0,1.0,alpha=0.5)) } # Create a 5 second sine wave of 1Hz w <- tuneR::sine(1, duration=5*44100) plot(w@left, type=\"l\", xlab=\"Time (samples)\", ylab=\"Amplitude\") windowing(w, window.length=44100, window.overlap = 0, FUN=drawWindow) plot(w@left, type=\"l\", xlab=\"Time (samples)\", ylab=\"Amplitude\") windowing(w, window.length=44100, window.overlap = 44100/2, FUN=drawWindow) plot(w@left, type=\"l\", xlab=\"Time (samples)\", ylab=\"Amplitude\") windowing(w, window.length=44100, window.overlap = -44100, FUN=drawWindow) w <- tuneR::sine(1, duration=5*44100) addNoise <- function(w, start, window.length) { nw <- tuneR::noise(\"white\", duration=length(w@left), samp.rate=w@samp.rate, pcm=w@pcm, bit=w@bit) rw <- w + nw/max(nw@left) # Scale noise to the amplitude of the sine wave return(rw) } o <- windowing(w, window.length=44100, window.overlap = -44100, FUN=addNoise, bind.wave=TRUE) plot(o@left, type=\"l\", xlab=\"Time (samples)\", ylab=\"Amplitude\")"},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/manage_audio.html","id":"taggedwave-workflow","dir":"Articles","previous_headings":"","what":"TaggedWave workflow","title":"Managing audio in R","text":"techniques can applied generic Wave WaveMC objects tuneR package. TaggedWave class extends Wave class tuneR package can include extended metadata results analyses. allows storage additional information audio file, location time recording, results analyses. tagWave() function can used tag Wave WaveMC object additional metadata. addition, combined new classes WaveAugment, WaveFilter, WaveAnalyse possible create self-documenting pipeline audio processing analysis (also compatible R pipe).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/other-apps.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Interacting with other tools","text":"sonicscrewdriver package provides number functions interacting audio tools software. vignette provides overview functions available interacting tools.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/other-apps.html","id":"audacity","dir":"Articles","previous_headings":"Interfaces with other tools","what":"Audacity","title":"Interacting with other tools","text":"Label files exported Audacity can read R using readAudacityLabels() function. function takes path label file returns list Annotation objects data frame start end times label label text. writeAudacityLabels() function can used write list Annotation objects Audacity label file.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/other-apps.html","id":"audioblast","dir":"Articles","previous_headings":"Interfaces with other tools","what":"AudioBlast","title":"Interacting with other tools","text":"audioBlast API can accessed using audioBlast() function. Files can downloaded API using audioBlastDownload() function.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/other-apps.html","id":"audiomoth","dir":"Articles","previous_headings":"Interfaces with other tools","what":"AudioMoth","title":"Interacting with other tools","text":"AudioMoth configuration files wave files can read R using audiomothConfig() audiomothWave() functions, respectively. audiomothConfig() function takes path configuration file returns data frame configuration settings. audiomothWave() function takes path wave file returns list extracted parameters.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/other-apps.html","id":"birdnet-analyzer","dir":"Articles","previous_headings":"Interfaces with other tools","what":"BirdNET Analyzer","title":"Interacting with other tools","text":"BirdNET Analyzer deep learning model automatic detection bird sounds. birdNetInstall() function can used install ssd_birdnet environment required use birdNetAnalyse() function SonicScrewdriver. birdNetAnalyse() function takes list sound files analyses using BirdNET-Analyzer. function either returns data frame results analysis list Annotation objects.","code":"# Install the Python environment pythonInstall() # Analyse sound files using BirdNET-Analyzer f <- system.file(\"extdata\", \"AUDIOMOTH.WAV\", package=\"sonicscrewdriver\") birdNetAnalyse(f, lat=51.5, lon=0.1, date=as.Date(\"2021-01-01\"))"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/other-apps.html","id":"scikit-maad","dir":"Articles","previous_headings":"Interfaces with other tools","what":"scikit-maad","title":"Interacting with other tools","text":"scikit-maad open source Python package dedicated quantitative analysis environmental audio recordings. sonicscrewdriver makes use reticulate package create Python environment interact scikit-maad. sonicscrewdriver scikit-maad functions prefixed maad_. functions provided accept standard Wave-like objects (.e. tuneR Wave WaveMC objects, well tagged equivalents package).","code":"# Install the Python environment pythonInstall() f <- system.file(\"extdata\", \"AUDIOMOTH.WAV\", package=\"sonicscrewdriver\") w <- readWave(f) maad_aci <- maad_acoustic_complexity_index(w)"},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/other-apps.html","id":"audio-file-with-annotations-from-audioblast-to-audacity","dir":"Articles","previous_headings":"Exemplar applications","what":"Audio file with annotations from audioBlast to Audacity","title":"Interacting with other tools","text":"audio file interest (id: 10754) recording Mole Cricket Gryllotalpa vineae BioAcoustica repository. Recordings annotations BioAcoustica made available audioBlast API. First download audio file annotations audioBlast. downloaded audio file mole_cricket directory. also saved metadata.csv file includes information audio file retrieved audioBlast. Next, download annotations file audioBlast. downloaded annotations audioBlast converted list Annotation objects. annotation data converted Annotation objects can easily manipulated number useful formats. case, convert Annotation objects Audacity label file. finished, can tidy workspace removing mole_cricket directory.","code":"# Find the file on audioblast data <- audioblast(\"data\", \"recordings\", source=\"bio.acousti.ca\", id=10754) # Download the file to the mole_cricket directory audioblastDownload(data, dir=\"mole_cricket/\") # Fetch annotations from audioBlast as `Annotation` objects a <- audioblast(\"data\", \"annomate\", source=\"bio.acousti.ca\", id=10754, output=\"Annotations\") # Convert the annotations to an Audacity label file writeAudacityLabels(a, \"mole_cricket/annotations.txt\") unlink(\"mole_cricket\", recursive=TRUE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/other-apps.html","id":"birdnet-analyzer-to-audacity-label-file","dir":"Articles","previous_headings":"","what":"BirdNET Analyzer to Audacity label file","title":"Interacting with other tools","text":"birdNetAnalyse() function can used analyse sound files using BirdNET-Analyzer. Get output BirdNET Analyzer list Annotation objects. Convert Annotation objects Audacity label file. Cleaning workspace.","code":"# Analyse sound files using BirdNET-Analyzer f <- system.file(\"extdata\", \"AUDIOMOTH.WAV\", package=\"sonicscrewdriver\") annotations <- birdNetAnalyse(f, output=\"Annotation\") # Convert the annotations to an Audacity label file writeAudacityLabels(annotations, \"birdnet_annotations.txt\") unlink(\"birdnet_annotations.txt\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/sonicscrewdriver.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"SonicScrewdriveR","text":"SonicScrewdriveR set tools various tasks faced bioacoustics researchers (users acoustics). tools relate management, processing, analysis, visualisation audio recordings.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/test-signals.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Generating acoustic test signals in R","text":"sonicscrewdriver package can used generate variety acoustic test signals.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/test-signals.html","id":"sine-sweeps","dir":"Articles","previous_headings":"","what":"Sine sweeps","title":"Generating acoustic test signals in R","text":"sine sweep signal increases frequency time. sweptsine() function can used generate sine sweep signal. following example generates sine sweep signal starts 20 Hz ends 20 kHz. default linear sweeps generated, also possible generate logarithmic sweeps setting mode argument \"log\".","code":"sweep <- sweptsine(20, 20000) seewave::spectro(sweep) par(mfrow=c(2,1)) sweep <- sweptsine(1, 100) seewave::oscillo(sweep, title=\"Linear\") sweep <- sweptsine(1, 100, mode=\"log\") seewave::oscillo(sweep, title=\"Logarithmic\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Ed Baker. Author, maintainer. Quentin Geissman. Contributor.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Baker E (2021). SonicScrewdriveR. https://cran.r-project.org/package=sonicscrewdriver.","code":"@Manual{, title = {SonicScrewdriveR}, author = {Ed Baker}, year = {2021}, url = {https://cran.r-project.org/package=sonicscrewdriver}, }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/index.html","id":"sonicscrewdriver-","dir":"","previous_headings":"","what":"Bioacoustic Analysis and Publication Tools","title":"Bioacoustic Analysis and Publication Tools","text":"package provides tools manipulating sound files analysis visualisation. SonicScrewdriveR can: Easily read audio files many types. Work seamlessly multi-channel audio. Read/write/convert audio metadata formats used tools. Apply filters audio. Augment audio data machine learning. Visualise audio data. Create self-documenting analysis pipelines. need SonicScrewdriveR arose initially Automated Acoustic Observatories project University York, later development audioBlast. projects required ability read manipulate audio files variety formats visualise analyse data contained within . package designed flexible possible able handle audio file formats differing encoding, channel numbers, sample rates. one sense, can seen wrapper around existing packages provide unified interface, also offers many new functions visualisations.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/index.html","id":"cran","dir":"","previous_headings":"Installation","what":"CRAN","title":"Bioacoustic Analysis and Publication Tools","text":"","code":"install.packages(\"sonicscrewdriver\") library(sonicscrewdriver)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/index.html","id":"latest-master","dir":"","previous_headings":"Installation","what":"Latest master","title":"Bioacoustic Analysis and Publication Tools","text":"Development version documentation","code":"install.packages(\"devtools\") devtools::install_github(\"edwbaker/SonicScrewdriveR\") library(sonicscrewdriver)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"Bioacoustic Analysis and Publication Tools","text":"Usage package described following vignettes: Managing audio R SonicScrewdriveR covers basics reading audio files readAudio(), performing analyses audio channels using allChannels() performing analysis sections audio windowing(). Augmenting audio R SonicScrewdriveR covers audio data augmentation. Using apps tools R using SonicScrewdriveR lists functions available interface apps tools audioBlast, Audacity AudioMoth. also gives exemplar applications using SonicScrewdriveR move data different tools platforms. Using SonicScrewriveR audioBlast covers use audioblast() find recordings, annotations, traits analyses. audioblastDownload() can used download files find using audioBlast. book Visualisation bioacoustics ecoacoustics R provides details various visualisation tools available packages. Converting code work SonicScrewdriveR provides guidance package developers end users want convert code work SonicScrewdriveR types TaggedWave TaggedWaveMC.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/index.html","id":"contributing","dir":"","previous_headings":"","what":"Contributing","title":"Bioacoustic Analysis and Publication Tools","text":"welcome contributions anyone like help improve package. want talk us submitting pull request feel free email Ed edward.baker@nhm.ac.uk. Please note ‘SonicScrewdriveR’ project released Contributor Code Conduct.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/index.html","id":"issue-reporting","dir":"","previous_headings":"Contributing","what":"Issue reporting","title":"Bioacoustic Analysis and Publication Tools","text":"find bug, feature request, please report issue tracker many details possible. package fails give useful error message, bug. package accepts invalid input without warning, bug. documentation unclear omits important information, bug. unsure something bug, please report .","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/index.html","id":"credits","dir":"","previous_headings":"","what":"Credits","title":"Bioacoustic Analysis and Publication Tools","text":"Initial development SonicScrewdriveR done Ed Baker supported Leverhulme Trust funded Automated Acoustic Observatories project University York, later developed support analysis functionality audioBlast. SonicScrewdriveR currently developed Natural History Museum, London.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/Annotation-class.html","id":null,"dir":"Reference","previous_headings":"","what":"A S4 class for annotations — Annotation-class","title":"A S4 class for annotations — Annotation-class","text":"Annotation class used store annotations Wave-like objects.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/Annotation-class.html","id":"slots","dir":"Reference","previous_headings":"","what":"Slots","title":"A S4 class for annotations — Annotation-class","text":"file File annotated. metadata list storing metadata. start Start time annotation. end End time annotation. low Low frequency annotation. high High frequency annotation. source Source annotation. type Type annotation. value Value annotation.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/PseudoWave-class.html","id":null,"dir":"Reference","previous_headings":"","what":"An S4 class to represent a PseudoWave object that is converted to a Wave object when operated on. — PseudoWave-class","title":"An S4 class to represent a PseudoWave object that is converted to a Wave object when operated on. — PseudoWave-class","text":"S4 class represent PseudoWave object converted Wave object operated .","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/PseudoWave-class.html","id":"slots","dir":"Reference","previous_headings":"","what":"Slots","title":"An S4 class to represent a PseudoWave object that is converted to a Wave object when operated on. — PseudoWave-class","text":"type Type PseudoWave (e.g. \"noise\") subtype Subtype PseudoWave (e.g. \"white\" type \"noise\") scale Wave channels multiplied value offset value added Wave channels seed Random seed reproducible output, NA seed scale Logical. Whether use random seed value params List additional parameters pass generating function","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/PseudoWave-numeric-method.html","id":null,"dir":"Reference","previous_headings":"","what":"PseudoWave scalar subtraction — -,PseudoWave,numeric-method","title":"PseudoWave scalar subtraction — -,PseudoWave,numeric-method","text":"PseudoWave scalar subtraction","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/PseudoWave-numeric-method.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"PseudoWave scalar subtraction — -,PseudoWave,numeric-method","text":"","code":"# S4 method for class 'PseudoWave,numeric' e1 - e2"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/PseudoWave-numeric-method.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"PseudoWave scalar subtraction — -,PseudoWave,numeric-method","text":"e1 Input 1 e2 Input 2","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/STP.html","id":null,"dir":"Reference","previous_headings":"","what":"STP: Standard Temperature and Pressure — STP","title":"STP: Standard Temperature and Pressure — STP","text":"Dataset compiled various sources differing values STP.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/STP.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"STP: Standard Temperature and Pressure — STP","text":"","code":"STP"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/STP.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"STP: Standard Temperature and Pressure — STP","text":"object class list length 2.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/TaggedWave-class.html","id":null,"dir":"Reference","previous_headings":"","what":"A S4 class for tagged waves — TaggedWave-class","title":"A S4 class for tagged waves — TaggedWave-class","text":"TaggedWave class extended Wave class tuneR package can include extended metadata results analyses.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/TaggedWave-class.html","id":"slots","dir":"Reference","previous_headings":"","what":"Slots","title":"A S4 class for tagged waves — TaggedWave-class","text":"metadata list storing metadata. analyses list storing analyses.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/TaggedWaveMC-class.html","id":null,"dir":"Reference","previous_headings":"","what":"A S4 class for tagged multi-channel waves — TaggedWaveMC-class","title":"A S4 class for tagged multi-channel waves — TaggedWaveMC-class","text":"TaggedWaveMC class extended WaveMC class tuneR package can include extended metadata results analyses.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/TaggedWaveMC-class.html","id":"slots","dir":"Reference","previous_headings":"","what":"Slots","title":"A S4 class for tagged multi-channel waves — TaggedWaveMC-class","text":"metadata list storing metdata. analyses list storing analyses.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/TimeRegion-class.html","id":null,"dir":"Reference","previous_headings":"","what":"An S4 class to represent a TimeRegion within a Wave object. — TimeRegion-class","title":"An S4 class to represent a TimeRegion within a Wave object. — TimeRegion-class","text":"S4 class represent TimeRegion within Wave object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/TimeRegion-class.html","id":"slots","dir":"Reference","previous_headings":"","what":"Slots","title":"An S4 class to represent a TimeRegion within a Wave object. — TimeRegion-class","text":"Start position End position unit Time unit (one seconds, minutes, hours)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/WaveFilter-class.html","id":null,"dir":"Reference","previous_headings":"","what":"WaveFilter object for audio filters — WaveFilter-class","title":"WaveFilter object for audio filters — WaveFilter-class","text":"WaveFilter object object containing information necessary filterWave() function apply filter Wave TaggedWave object. designed allow pipe operator (either magrittr base R) used apply filters Wave pipeline. used TaggedWave object function adds information processing slot documenting action.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/WaveFilter-class.html","id":"slots","dir":"Reference","previous_headings":"","what":"Slots","title":"WaveFilter object for audio filters — WaveFilter-class","text":"description Description filter. func Name function. params List additional parameters pass function.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ab_diel_traits.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert text times of day in audioblast traits to numeric values — ab_diel_traits","title":"Convert text times of day in audioblast traits to numeric values — ab_diel_traits","text":"function takes traits dataset retrieved audioblast converts values \"day\" numeric time day based date location.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ab_diel_traits.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert text times of day in audioblast traits to numeric values — ab_diel_traits","text":"","code":"ab_diel_traits(traits, date, lat, lon, overwrite = FALSE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ab_diel_traits.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert text times of day in audioblast traits to numeric values — ab_diel_traits","text":"traits Traits dataset retrieved using audioblast(). date date used conversion time. lat Latitude location. lon Longitude location. overwrite TRUE function overwrite existing min/max.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/addProcess-methods.html","id":null,"dir":"Reference","previous_headings":"","what":"Add a process to a Tagged Wave or WaveMC object — addProcess","title":"Add a process to a Tagged Wave or WaveMC object — addProcess","text":"function takes TaggedWave TaggedWaveMC object adds process processing slot. used keep record processes applied object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/addProcess-methods.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add a process to a Tagged Wave or WaveMC object — addProcess","text":"","code":"addProcess(object, process, output = NULL, duration = NULL) # S4 method for class 'TaggedWave' addProcess(object, process, output = NULL, duration = NULL) # S4 method for class 'TaggedWaveMC' addProcess(object, process, output = NULL, duration = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/addProcess-methods.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add a process to a Tagged Wave or WaveMC object — addProcess","text":"object object. process description process. output output process. duration duration process seconds.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/addProcess-methods.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add a process to a Tagged Wave or WaveMC object — addProcess","text":"object process added.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/addSpectra.html","id":null,"dir":"Reference","previous_headings":"","what":"Add two spectra from seewave — addSpectra","title":"Add two spectra from seewave — addSpectra","text":"function takes two spectra seewave (equivalent) adds values. spectra must bins.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/addSpectra.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add two spectra from seewave — addSpectra","text":"","code":"addSpectra(s1, s2, coerceNegative = TRUE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/addSpectra.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add two spectra from seewave — addSpectra","text":"s1 First spectrum s2 Second spectrum coerceNegative Sets values zero zero output.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/addSpectra.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add two spectra from seewave — addSpectra","text":"spectrum s1+s2","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/addSpectra.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Add two spectra from seewave — addSpectra","text":"","code":"if (FALSE) { # \\dontrun{ subtractSpectra(spec1, spec2) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/allChannels.html","id":null,"dir":"Reference","previous_headings":"","what":"Apply a function to all channels of a Wave or WaveMC object — allChannels","title":"Apply a function to all channels of a Wave or WaveMC object — allChannels","text":"functions (e.g. ffilter seewave) operate single channel time. function applies function channel returns list analyses.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/allChannels.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Apply a function to all channels of a Wave or WaveMC object — allChannels","text":"","code":"allChannels( w, FUN, cl = NULL, channel.param = \"channel\", output.FUN = NULL, ... )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/allChannels.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Apply a function to all channels of a Wave or WaveMC object — allChannels","text":"w Wave WaveMC object FUN Function apply wave. cl Optionally cluster parallel calculation. channel.param Name channel parameter FUN. Can NULL. output.FUN Optional. Function processes output FUN. \"channels_se\" function provides standard functionality soundecology package. ... Optional. Additional parameters pass FUN.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/allChannels.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Apply a function to all channels of a Wave or WaveMC object — allChannels","text":"list outputs.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/annotation.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a new Annotation object — annotation","title":"Create a new Annotation object — annotation","text":"Create new Annotation object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/annotation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a new Annotation object — annotation","text":"","code":"annotation( file = NA_character_, metadata = list(), start = 0, end = Inf, low = 0, high = Inf, source = NA_character_, type = NA_character_, value = NA_character_ )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/annotation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a new Annotation object — annotation","text":"file File annotated. metadata list metadata. start Start time annotation (seconds). end End time annotation (seconds). low Low frequency annotation (Hz). high High frequency annotation (Hz). source Source annotation. type Type annotation. value Value annotation.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/annotation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a new Annotation object — annotation","text":"Annotation object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/annotations_merge.html","id":null,"dir":"Reference","previous_headings":"","what":"Combine annotations — annotations_merge","title":"Combine annotations — annotations_merge","text":"Checks list annotations overlapping, returns list overlapping annotations merged.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/annotations_merge.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Combine annotations — annotations_merge","text":"","code":"annotations_merge(annotations, domain = \"time\", same.source = TRUE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/annotations_merge.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Combine annotations — annotations_merge","text":"annotations list Annotation objects. domain Domain annotations, either \"time\", \"frequency\", \"\". .source TRUE, annotations must source merged.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/annotations_merge.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Combine annotations — annotations_merge","text":"list Annotation objects.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audio_filesize.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculated size of raw audio files — audio_filesize","title":"Calculated size of raw audio files — audio_filesize","text":"Calculates raw size audio date set sample rate, bit depth duration.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audio_filesize.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculated size of raw audio files — audio_filesize","text":"","code":"audio_filesize( samp.rate = 44100, bit.depth = 16, channels = 1, duration = 1, duration.unit = \"seconds\", output.unit = \"bits\" )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audio_filesize.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculated size of raw audio files — audio_filesize","text":"samp.rate Sample rate bit.depth Bit depth channels number audio channels duration Duration recording duration.unit One seconds, minutes, hours, days output.unit \"human\", \"bits\" \"bytes\"","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audio_filesize.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Calculated size of raw audio files — audio_filesize","text":"size audio file specified unit","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audio_filesize.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Calculated size of raw audio files — audio_filesize","text":"default humanBytes() used convert output human readable format, however can changed setting output.unit \"bits\" \"bytes\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audio_filesize.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Calculated size of raw audio files — audio_filesize","text":"","code":"# One minute of mono 16-bit audio sampled at 44.1kHz audio_filesize(samp.rate=44100, bit.depth=16, channels=1, duration=1, duration.unit=\"minutes\") #> [1] 42336000 # One year of stereo 24-bit audio sampled at 96kHz audio_filesize(samp.rate=96000, bit.depth=24, channels=2, duration=1, duration.unit=\"years\") #> [1] 1.453179e+14"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audioblast.html","id":null,"dir":"Reference","previous_headings":"","what":"Get data or analyses from audioBlast — audioblast","title":"Get data or analyses from audioBlast — audioblast","text":"Search data analyses audioBlast.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audioblast.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get data or analyses from audioBlast — audioblast","text":"","code":"audioblast( type, name, endpoint = NULL, check = TRUE, max_pages = NULL, page = 1, quiet = FALSE, on.issue = stop, output = \"data.frame\", ... )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audioblast.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get data or analyses from audioBlast — audioblast","text":"type One data, analysis, standalone. name Name data analysis source. endpoint Optionally specify endpoint audioBlast module. check Logical. Performs sanity check input sending audioBLAST. max_pages Maximum number data pages return, default set NULL returns pages. page First page results request, defaults 1. quiet true print progress. Silence virtue. .issue Function call error warning. default stop raise standard R error. Setting warning instead warning. output default data.frame. \"Annotations\" return list Annotation objects. ... Fields values filter . field defined audioBLAST.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audioblast.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get data or analyses from audioBlast — audioblast","text":"data frame","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audioblast.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get data or analyses from audioBlast — audioblast","text":"","code":"if (FALSE) { # \\dontrun{ audioblast(\"data\", \"recordings\", taxon=\"Gryllotalpa vineae\") } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audioblastDownload.html","id":null,"dir":"Reference","previous_headings":"","what":"Download audio files from audioBlast — audioblastDownload","title":"Download audio files from audioBlast — audioblastDownload","text":"Downloads audio files associated search using audioBlast() function.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audioblastDownload.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download audio files from audioBlast — audioblastDownload","text":"","code":"audioblastDownload( d, metadata = TRUE, skip.existing = TRUE, dir = \".\", quiet = FALSE, on.issue = .audioblastIssue )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audioblastDownload.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download audio files from audioBlast — audioblastDownload","text":"d Data returned search using audioBlast(). metadata true saves data d csv file. skip.existing true overwrite existing files. dir Directory save files . quiet true print progress. .issue Function call error warning. default stop raise standard R error. Setting warning instead warning.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothConfig.html","id":null,"dir":"Reference","previous_headings":"","what":"Read AudioMoth configuration file — audiomothConfig","title":"Read AudioMoth configuration file — audiomothConfig","text":"Reads parses AudioMoth configuration file.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothConfig.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read AudioMoth configuration file — audiomothConfig","text":"","code":"audiomothConfig(filename)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothConfig.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read AudioMoth configuration file — audiomothConfig","text":"filename Path configuration file read","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothConfig.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read AudioMoth configuration file — audiomothConfig","text":"data frame matching annotations","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothConfig.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Read AudioMoth configuration file — audiomothConfig","text":"","code":"if (FALSE) { # \\dontrun{ audiomothConfig(\"./CONFIG.TXT\") } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothWave.html","id":null,"dir":"Reference","previous_headings":"","what":"Read AudioMoth metadata from a wave file — audiomothWave","title":"Read AudioMoth metadata from a wave file — audiomothWave","text":"Reads parses metadata stored wave files produced AudioMoth devices.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothWave.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read AudioMoth metadata from a wave file — audiomothWave","text":"","code":"audiomothWave(filename)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothWave.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read AudioMoth metadata from a wave file — audiomothWave","text":"filename Path wave file read","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothWave.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read AudioMoth metadata from a wave file — audiomothWave","text":"list extracted parameters","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothWave.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Read AudioMoth metadata from a wave file — audiomothWave","text":"","code":"if (FALSE) { # \\dontrun{ audiomothWave(\"./FILENAME.WAV\") } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/autoBandPass.html","id":null,"dir":"Reference","previous_headings":"","what":"Automatic Band Pass Filter — autoBandPass","title":"Automatic Band Pass Filter — autoBandPass","text":"Creates automatic bandpass filter based strongest frequency. allowed bandwidth can integer multiple bandwidth either -3dB -10dB.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/autoBandPass.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Automatic Band Pass Filter — autoBandPass","text":"","code":"autoBandPass(wave, bw = \"-3dB\", n.bw = 1, lowcut = 1000)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/autoBandPass.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Automatic Band Pass Filter — autoBandPass","text":"wave Wave object bw Either -3dB -10dB. calculated frequencyStats n.bw number bandwidths either side centre centre keep lowcut High-pass filtering applied frequency calculating centre frequency bandwidth","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/autoBandPass.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Automatic Band Pass Filter — autoBandPass","text":"band-pass filtered Wave object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/autoBandPass.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Automatic Band Pass Filter — autoBandPass","text":"","code":"if (FALSE) { # \\dontrun{ autoBandPass(sheep) autoBandPass(sheep, bw=\"-3dB\", n.bw=1, lowcut=1000) autoBandPass(sheep, bw=\"-10dB\", n.bw=2, lowcut=0) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/bandpass.html","id":null,"dir":"Reference","previous_headings":"","what":"Simple bandpass filter — bandpass","title":"Simple bandpass filter — bandpass","text":"Creates band pass WaveFilter values specified Wave object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/bandpass.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Simple bandpass filter — bandpass","text":"","code":"bandpass(from, to, ...)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/bandpass.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Simple bandpass filter — bandpass","text":"Bottom bandpass frequency (Hz). Top bandpass frequency (Hz). ... arguments pass ffilter.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/bandpass.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Simple bandpass filter — bandpass","text":"WaveFilter object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/bandpass.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Simple bandpass filter — bandpass","text":"simple wrapper function seewave ffilter function allowing use filterw pipes.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/bandpass.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Simple bandpass filter — bandpass","text":"","code":"if (FALSE) { # \\dontrun{ nwave <- noise(\"white\", duration=44100, samp.rate=44100) fwave <- filterWave(nwave, bandpass(from=1000, to=2000)) nwave |> filterWave(bandpass(from=1000, to=2000)) -> fwave } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatComplexity.html","id":null,"dir":"Reference","previous_headings":"","what":"Beat spectrum complexity — beatComplexity","title":"Beat spectrum complexity — beatComplexity","text":"function computes beatSpectrum calculates basic measurements complexity. complexity value calculated maximum identified repeating period (seconds) divided number peaks.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatComplexity.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Beat spectrum complexity — beatComplexity","text":"","code":"beatComplexity(wave, plot = FALSE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatComplexity.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Beat spectrum complexity — beatComplexity","text":"wave Wave object plot TRUE spectrogram overlaid peaks plotted.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatComplexity.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Beat spectrum complexity — beatComplexity","text":"list complexity, vector peak periods, number peaks.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatComplexity.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Beat spectrum complexity — beatComplexity","text":"","code":"if (FALSE) { # \\dontrun{ beatComplexity(sheep) beatComplexity(sheep, plot=TRUE) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatSpectrum.html","id":null,"dir":"Reference","previous_headings":"","what":"Computes a beat spectrum — beatSpectrum","title":"Computes a beat spectrum — beatSpectrum","text":"Beat spectra represent periodicity signal amplitude. computed performing continuous wavelet transform envelope preprocessed signal, processing average power per frequency band.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatSpectrum.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Computes a beat spectrum — beatSpectrum","text":"","code":"beatSpectrum(wave, min_period = 0.005, max_period = 30, dj = 1/32, ...)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatSpectrum.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Computes a beat spectrum — beatSpectrum","text":"wave R object path wave file min_period minimal rythmicity period expected, seconds max_period maximal rythmicity period expected, seconds dj frequency resolution cwt (voices per octave) ... extra arguments passed analyze.wavelet()","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatSpectrum.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Computes a beat spectrum — beatSpectrum","text":"spectrum data frame. contains two columns: power period. number rows depend resolution frequency range.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatSpectrum.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"Computes a beat spectrum — beatSpectrum","text":"Quentin Geissmann","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatSpectrum.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Computes a beat spectrum — beatSpectrum","text":"","code":"if (FALSE) { # \\dontrun{ beatSpectrum(sheep) beatSpectrum(sheep, min_period=0.005, max_period=30, dj=1/32) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/birdNetAnalyse.html","id":null,"dir":"Reference","previous_headings":"","what":"Analyse sound files using BirdNET-Analyzer — birdNetAnalyse","title":"Analyse sound files using BirdNET-Analyzer — birdNetAnalyse","text":"function takes list sound files analyses using BirdNET-Analyzer birdnet2021sonicscrewdriver. function either returns data frame results analysis list Annotation objects.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/birdNetAnalyse.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Analyse sound files using BirdNET-Analyzer — birdNetAnalyse","text":"","code":"birdNetAnalyse( files, lat = NULL, lon = NULL, date = NULL, output = \"Annotation\" )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/birdNetAnalyse.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Analyse sound files using BirdNET-Analyzer — birdNetAnalyse","text":"files character vector file paths. lat latitude vector latitudes. lon longitude vector longitudes. date Date list Date objects . output One \"data.frame\" \"Annotation\".","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/birdNetAnalyse.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Analyse sound files using BirdNET-Analyzer — birdNetAnalyse","text":"","code":"if (FALSE) { # \\dontrun{ birdnetAnalyse(files=c(\"path/to/file1.wav\", \"path/to/file2.wav\"), output=\"data.frame\") } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/channels_se.html","id":null,"dir":"Reference","previous_headings":"","what":"Channels for sound ecology — channels_se","title":"Channels for sound ecology — channels_se","text":"Used process output acoustic index functions soundecology package using allChannels.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/channels_se.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Channels for sound ecology — channels_se","text":"","code":"channels_se(...)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/channels_se.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Channels for sound ecology — channels_se","text":"... Export bioacoustic index function soundecology package","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/circularise.html","id":null,"dir":"Reference","previous_headings":"","what":"Circularise a dataset — circularise","title":"Circularise a dataset — circularise","text":"plotting rings horizons meant cover entirety time period dielPlot() yearlyPlot() function append beginning values end ensure entire loop created.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/circularise.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Circularise a dataset — circularise","text":"","code":"circularise(values)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/circularise.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Circularise a dataset — circularise","text":"values vector values","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/concat-methods.html","id":null,"dir":"Reference","previous_headings":"","what":"Concatenate two or more Wave-like objects. — concat","title":"Concatenate two or more Wave-like objects. — concat","text":"concat() method flexible version bind() method tuneR package, allows specifying advanced types concatenation. Setting method \"noClick\" remove click Wave objects caused sudden jumps amplitude applying tuneR::prepComb() appropriately default value zero (effective left channel stereo multi-channel recordings).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/concat-methods.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Concatenate two or more Wave-like objects. — concat","text":"","code":"concat(object, ..., method = \"bind\") # S4 method for class 'Wave' concat(object, ..., method = \"bind\") # S4 method for class 'WaveMC' concat(object, ..., method = \"bind\") # S4 method for class 'TaggedWave' concat(object, ..., method = \"bind\") # S4 method for class 'TaggedWaveMC' concat(object, ..., method = \"bind\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/concat-methods.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Concatenate two or more Wave-like objects. — concat","text":"object Wave like object. ... Wave like objects concatenate object. method One \"bind\", \"noClick\". Default \"bind\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/concat-methods.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Concatenate two or more Wave-like objects. — concat","text":"concatenated Wave like object, type object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Celsius.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert temperature to Celsius — convert2Celsius","title":"Convert temperature to Celsius — convert2Celsius","text":"Converts temperature measurements Celsius","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Celsius.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert temperature to Celsius — convert2Celsius","text":"","code":"convert2Celsius(temp, input = \"K\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Celsius.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert temperature to Celsius — convert2Celsius","text":"temp value temperature convert input unit temperature convert, allowed values \"K\", \"F\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Celsius.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert temperature to Celsius — convert2Celsius","text":"Numeric value degrees Celsius","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Celsius.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert temperature to Celsius — convert2Celsius","text":"","code":"convert2Celsius(15, input=\"K\") #> [1] -258.15 convert2Celsius(15, input=\"F\") #> [1] -9.444444"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Fahrenheit.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert temperature to Fahrenheit — convert2Fahrenheit","title":"Convert temperature to Fahrenheit — convert2Fahrenheit","text":"Converts temperature measurements Fahrenheit","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Fahrenheit.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert temperature to Fahrenheit — convert2Fahrenheit","text":"","code":"convert2Fahrenheit(temp, input)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Fahrenheit.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert temperature to Fahrenheit — convert2Fahrenheit","text":"temp value temperature convert input unit temperature convert, allowed values \"K\", \"C\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Fahrenheit.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert temperature to Fahrenheit — convert2Fahrenheit","text":"","code":"if (FALSE) { # \\dontrun{ convert2Fahrenheit(15, input = \"C\") } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Kelvin.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert temperature to Kelvin — convert2Kelvin","title":"Convert temperature to Kelvin — convert2Kelvin","text":"Converts temperature measurements Kelvin","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Kelvin.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert temperature to Kelvin — convert2Kelvin","text":"","code":"convert2Kelvin(temp, input = \"C\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Kelvin.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert temperature to Kelvin — convert2Kelvin","text":"temp value temperature convert input unit temperature convert, allowed values \"C\", \"F\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Kelvin.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert temperature to Kelvin — convert2Kelvin","text":"Numeric value Kelvin","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Kelvin.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert temperature to Kelvin — convert2Kelvin","text":"","code":"convert2Kelvin(15, input=\"C\") #> [1] 288.15 convert2Kelvin(15, input=\"F\") #> [1] 263.7056"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Pascals.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert pressure to Pascals — convert2Pascals","title":"Convert pressure to Pascals — convert2Pascals","text":"Converts pressure measurements Pascals","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Pascals.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert pressure to Pascals — convert2Pascals","text":"","code":"convert2Pascals(P, input = \"kPa\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Pascals.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert pressure to Pascals — convert2Pascals","text":"P value pressure convert input unit pressure convert, allowed values \"kPa\", \"dyne_cm2\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Pascals.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert pressure to Pascals — convert2Pascals","text":"numeric value Pascals","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Pascals.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert pressure to Pascals — convert2Pascals","text":"","code":"convert2Pascals(1000, input=\"kPa\") #> [1] 1e+06 convert2Pascals(10, input=\"dyne_cm2\") #> [1] 1"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2bytes.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert bits to bytes — convert2bytes","title":"Convert bits to bytes — convert2bytes","text":"Converts time measurements seconds","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2bytes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert bits to bytes — convert2bytes","text":"","code":"convert2bytes(S, input = \"bits\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2bytes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert bits to bytes — convert2bytes","text":"S value convert input unit convert, allowed values \"bits\", \"kB\", \"MB\", \"GB\"","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2bytes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert bits to bytes — convert2bytes","text":"numeric value seconds","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2degrees.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert angle to degrees — convert2degrees","title":"Convert angle to degrees — convert2degrees","text":"Converts angle measurements degrees","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2degrees.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert angle to degrees — convert2degrees","text":"","code":"convert2degrees(A, input = \"radians\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2degrees.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert angle to degrees — convert2degrees","text":"angle value convert input unit angle convert, allowed values \"radians\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2degrees.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert angle to degrees — convert2degrees","text":"numeric value degrees","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2dyne_cm2.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert pressure to dyne per square centimetre — convert2dyne_cm2","title":"Convert pressure to dyne per square centimetre — convert2dyne_cm2","text":"Converts pressure measurements dyne per square centimetre","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2dyne_cm2.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert pressure to dyne per square centimetre — convert2dyne_cm2","text":"","code":"convert2dyne_cm2(P, input = \"kPa\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2dyne_cm2.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert pressure to dyne per square centimetre — convert2dyne_cm2","text":"P value pressure convert input unit pressure convert, allowed values \"kPa\", \"P\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2dyne_cm2.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert pressure to dyne per square centimetre — convert2dyne_cm2","text":"","code":"convert2dyne_cm2(1, input=\"Pa\") #> [1] 10 convert2dyne_cm2(1, input=\"kPa\") #> [1] 10000"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2radians.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert angle to radians — convert2radians","title":"Convert angle to radians — convert2radians","text":"Converts angle measurements radians","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2radians.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert angle to radians — convert2radians","text":"","code":"convert2radians(A, input = \"degrees\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2radians.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert angle to radians — convert2radians","text":"angle value convert input unit angle convert, allowed values \"degrees\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2radians.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert angle to radians — convert2radians","text":"numeric value radians","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2seconds.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert time to seconds — convert2seconds","title":"Convert time to seconds — convert2seconds","text":"Converts time measurements seconds","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2seconds.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert time to seconds — convert2seconds","text":"","code":"convert2seconds(T, input = \"minutes\", origin = \"day\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2seconds.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert time to seconds — convert2seconds","text":"T time value convert input unit time convert, allowed values \"minutes\", \"hours\", \"days\", \"years\", \"HHMM\". origin POSIX whether return relative start day (\"day\") Unix epoch (\"unix\")","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2seconds.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert time to seconds — convert2seconds","text":"numeric value seconds","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/corWaveMC.html","id":null,"dir":"Reference","previous_headings":"","what":"Correlate channels in a WaveMC object — corWaveMC","title":"Correlate channels in a WaveMC object — corWaveMC","text":"Uses corenv function seewave calculate envelope correlation timed events channels WaveMC object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/corWaveMC.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Correlate channels in a WaveMC object — corWaveMC","text":"","code":"corWaveMC(wave, times, window, temp = 25, cluster = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/corWaveMC.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Correlate channels in a WaveMC object — corWaveMC","text":"wave WaveMC object times One times events correlate window Width window correlate seconds (centred times) temp Air temperature Celsius cluster cluster parallel execution","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/corWaveMC.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Correlate channels in a WaveMC object — corWaveMC","text":"List corenv lists events, list time differences channels","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/cutws.html","id":null,"dir":"Reference","previous_headings":"","what":"Cut wave by samples — cutws","title":"Cut wave by samples — cutws","text":"Extract section Wave object based sample positions. function automatically detect Wave object stereo.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/cutws.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Cut wave by samples — cutws","text":"","code":"cutws(wave, from = 1, to = Inf, plot = FALSE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/cutws.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Cut wave by samples — cutws","text":"wave Wave object First sample return Last sample return plot TRUE shows cut region within original waveform","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/cutws.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Cut wave by samples — cutws","text":"Wave object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/cutws.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Cut wave by samples — cutws","text":"","code":"if (FALSE) { # \\dontrun{ cutws(sheep, 1, 20) cutws(sheep, 1, 20, plot=TRUE) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/data2Wave.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert data into a Wave object — data2Wave","title":"Convert data into a Wave object — data2Wave","text":"Make sequence data normalised Wave object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/data2Wave.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert data into a Wave object — data2Wave","text":"","code":"data2Wave( left, samp.rate = 44100, bit = 16, unit = NULL, remove.offset = TRUE, normalise = TRUE )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/data2Wave.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert data into a Wave object — data2Wave","text":"left Data mono audio channel samp.rate Sampling rate Wave object bit Bit depth Wave object unit See tuneR::normalize. NULL handled automatically. remove.offset TRUE DC offset removed normalise TRUE output Wave normalised -1:1","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/data2Wave.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert data into a Wave object — data2Wave","text":"mono Wave object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/data2Wave.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert data into a Wave object — data2Wave","text":"","code":"pattern <- seq(from=-1, to=1, length.out=100) data <- rep.int(pattern, 100) w <- data2Wave(data)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dayPhase.html","id":null,"dir":"Reference","previous_headings":"","what":"Phase of day — dayPhase","title":"Phase of day — dayPhase","text":"Given start time (optionally) duration returns phase day given location. primarily used calculate phase day information soundscape recording projects.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dayPhase.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Phase of day — dayPhase","text":"","code":"dayPhase( time = Sys.time(), duration = 40000, lat = 50.1, lon = 1.83, tz = \"UTC\" )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dayPhase.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Phase of day — dayPhase","text":"time time object representing start time recording duration Duration recording lat Latitude recording device lon Longitude recording device tz Time-zone recording device recording made","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dayPhase.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Phase of day — dayPhase","text":"Data frame day phases absolute timestamps relative times within file","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dayPhases.html","id":null,"dir":"Reference","previous_headings":"","what":"Phases of day — dayPhases","title":"Phases of day — dayPhases","text":"Wrapper suncalc::getSunlightTimes formats output package.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dayPhases.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Phases of day — dayPhases","text":"","code":"dayPhases(time = as.Date(Sys.time()), lat = 50.1, lon = 1.83, tz = \"UTC\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dayPhases.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Phases of day — dayPhases","text":"time time object representing start time recording lat Latitude recording device lon Longitude recording device tz Time-zone recording device recording made","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/daysPhases.html","id":null,"dir":"Reference","previous_headings":"","what":"Phases of days — daysPhases","title":"Phases of days — daysPhases","text":"Phases days","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/daysPhases.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Phases of days — daysPhases","text":"","code":"daysPhases( date = Sys.Date(), period = \"year\", plot = FALSE, lat = 50.1, lon = 1.83, tz = \"UTC\" )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/daysPhases.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Phases of days — daysPhases","text":"date time object representing start time recording period \"month\" \"year\" plot true plots data, default FALSE lat Latitude recording device lon Longitude recording device tz Time-zone recording device recording made","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/defaultCluster.html","id":null,"dir":"Reference","previous_headings":"","what":"Create Default Cluster for Windowing — defaultCluster","title":"Create Default Cluster for Windowing — defaultCluster","text":"Creates default cluster using one less total cores available system. default uses forking, available Windows. Hence, fork parameter effect Windows.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/defaultCluster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create Default Cluster for Windowing — defaultCluster","text":"","code":"defaultCluster(fork = TRUE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/defaultCluster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create Default Cluster for Windowing — defaultCluster","text":"fork TRUE uses forking create cluster (Unix like systems )","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/defaultCluster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create Default Cluster for Windowing — defaultCluster","text":"cluster object parallel processing","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/defaultCluster.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create Default Cluster for Windowing — defaultCluster","text":"","code":"if (FALSE) { # \\dontrun{ cl <- defaultCluster() stopCluster(cl) cl <- defaultCluster(FALSE) stopCluster(cl) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielFraction.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate the fraction of a day given by a value — dielFraction","title":"Calculate the fraction of a day given by a value — dielFraction","text":"Given object can coerced POSIXlt supported string format, return fraction day represented object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielFraction.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate the fraction of a day given by a value — dielFraction","text":"","code":"dielFraction(t, input = \"POSIX\", unit = \"radians\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielFraction.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate the fraction of a day given by a value — dielFraction","text":"t Object converted fraction input One POSIX (default) HHMM unit set radians outputs position around circle. set fraction outputs raw fraction.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielHistogram.html","id":null,"dir":"Reference","previous_headings":"","what":"Diel Histogram — dielHistogram","title":"Diel Histogram — dielHistogram","text":"Draws histogram dielPlot() using pre-defined bins related time day.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielHistogram.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Diel Histogram — dielHistogram","text":"","code":"dielHistogram( times, by = \"hour\", col = \"grey\", maxval = NA, presence.only = FALSE, limits = c(1, 2) )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielHistogram.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Diel Histogram — dielHistogram","text":"times vector times can pocessed dielFraction(). Controls size histogram bins, one \"hour\", \"15minute\", \"30minute\". col Colour plot. maxval default scales histogram within limits, specifying maximum value allows comparison plots. presence.show presence/absence values. limits Limits plotting (see dielPlot()).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielHistogram.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Diel Histogram — dielHistogram","text":"data frame start end points bins.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielLabels.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate labels for a diel plot — dielLabels","title":"Generate labels for a diel plot — dielLabels","text":"Generates labels dielPlot() 12- 24-hour format. Labels generated three hourly intervals.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielLabels.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate labels for a diel plot — dielLabels","text":"","code":"dielLabels(format = \"clock24\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielLabels.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate labels for a diel plot — dielLabels","text":"format One clock24 (default) clock12","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielLabels.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate labels for a diel plot — dielLabels","text":"","code":"dielLabels() #> [1] \"0000\" \"0300\" \"0600\" \"0900\" \"1200\" \"1500\" \"1800\" \"2100\" dielLabels(\"clock12\") #> [1] \"0000\" \"0300 AM\" \"0600 AM\" \"0900 AM\" \"1200 NOON\" \"0300 PM\" #> [7] \"0600 PM\" \"0900 PM\""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielPlot.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a diel plot — dielPlot","title":"Create a diel plot — dielPlot","text":"diel plot shows times night, twilight maximum altitude sun given date.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielPlot.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a diel plot — dielPlot","text":"","code":"dielPlot( date, lat, lon, limits = c(0, 2), plot = NULL, rot = tzRot(0), method = \"plotrix\", legend = F )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielPlot.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a diel plot — dielPlot","text":"date Date plot. lat Numeric latitude. lon Numeric longitude. limits Plotting limits daylight regions, default c(1,2) plot Character vector components plot rot Either \"Solar Noon\" offset calculated tz method Plotting library use legend Whether show legend","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielPositions.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate positions of labels for a diel plot — dielPositions","title":"Generate positions of labels for a diel plot — dielPositions","text":"Generates positions three-hourly labels dielPlot() radians.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielPositions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate positions of labels for a diel plot — dielPositions","text":"","code":"dielPositions(format = \"3hourly\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielPositions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate positions of labels for a diel plot — dielPositions","text":"format One \"3hours\" (default), \"hours\", \"minutes\"","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielPositions.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate positions of labels for a diel plot — dielPositions","text":"","code":"dielPositions() #> [1] 0.0000000 0.7853982 1.5707963 2.3561945 3.1415927 3.9269908 4.7123890 #> [8] 5.4977871 dielPositions(\"hours\") #> [1] 0.2617994 0.5235988 0.7853982 1.0471976 1.3089969 1.5707963 1.8325957 #> [8] 2.0943951 2.3561945 2.6179939 2.8797933 3.1415927 3.4033920 3.6651914 #> [15] 3.9269908 4.1887902 4.4505896 4.7123890 4.9741884 5.2359878 5.4977871 #> [22] 5.7595865 6.0213859 6.2831853 dielPositions(\"minutes\") #> [1] 0.004363323 0.008726646 0.013089969 0.017453293 0.021816616 0.026179939 #> [7] 0.030543262 0.034906585 0.039269908 0.043633231 0.047996554 0.052359878 #> [13] 0.056723201 0.061086524 0.065449847 0.069813170 0.074176493 0.078539816 #> [19] 0.082903139 0.087266463 0.091629786 0.095993109 0.100356432 0.104719755 #> [25] 0.109083078 0.113446401 0.117809725 0.122173048 0.126536371 0.130899694 #> [31] 0.135263017 0.139626340 0.143989663 0.148352986 0.152716310 0.157079633 #> [37] 0.161442956 0.165806279 0.170169602 0.174532925 0.178896248 0.183259571 #> [43] 0.187622895 0.191986218 0.196349541 0.200712864 0.205076187 0.209439510 #> [49] 0.213802833 0.218166156 0.222529480 0.226892803 0.231256126 0.235619449 #> [55] 0.239982772 0.244346095 0.248709418 0.253072742 0.257436065 0.261799388 #> [61] 0.266162711 0.270526034 0.274889357 0.279252680 0.283616003 0.287979327 #> [67] 0.292342650 0.296705973 0.301069296 0.305432619 0.309795942 0.314159265 #> [73] 0.318522588 0.322885912 0.327249235 0.331612558 0.335975881 0.340339204 #> [79] 0.344702527 0.349065850 0.353429174 0.357792497 0.362155820 0.366519143 #> [85] 0.370882466 0.375245789 0.379609112 0.383972435 0.388335759 0.392699082 #> [91] 0.397062405 0.401425728 0.405789051 0.410152374 0.414515697 0.418879020 #> [97] 0.423242344 0.427605667 0.431968990 0.436332313 0.440695636 0.445058959 #> [103] 0.449422282 0.453785606 0.458148929 0.462512252 0.466875575 0.471238898 #> [109] 0.475602221 0.479965544 0.484328867 0.488692191 0.493055514 0.497418837 #> [115] 0.501782160 0.506145483 0.510508806 0.514872129 0.519235452 0.523598776 #> [121] 0.527962099 0.532325422 0.536688745 0.541052068 0.545415391 0.549778714 #> [127] 0.554142038 0.558505361 0.562868684 0.567232007 0.571595330 0.575958653 #> [133] 0.580321976 0.584685299 0.589048623 0.593411946 0.597775269 0.602138592 #> [139] 0.606501915 0.610865238 0.615228561 0.619591884 0.623955208 0.628318531 #> [145] 0.632681854 0.637045177 0.641408500 0.645771823 0.650135146 0.654498469 #> [151] 0.658861793 0.663225116 0.667588439 0.671951762 0.676315085 0.680678408 #> [157] 0.685041731 0.689405055 0.693768378 0.698131701 0.702495024 0.706858347 #> [163] 0.711221670 0.715584993 0.719948316 0.724311640 0.728674963 0.733038286 #> [169] 0.737401609 0.741764932 0.746128255 0.750491578 0.754854901 0.759218225 #> [175] 0.763581548 0.767944871 0.772308194 0.776671517 0.781034840 0.785398163 #> [181] 0.789761487 0.794124810 0.798488133 0.802851456 0.807214779 0.811578102 #> [187] 0.815941425 0.820304748 0.824668072 0.829031395 0.833394718 0.837758041 #> [193] 0.842121364 0.846484687 0.850848010 0.855211333 0.859574657 0.863937980 #> [199] 0.868301303 0.872664626 0.877027949 0.881391272 0.885754595 0.890117919 #> [205] 0.894481242 0.898844565 0.903207888 0.907571211 0.911934534 0.916297857 #> [211] 0.920661180 0.925024504 0.929387827 0.933751150 0.938114473 0.942477796 #> [217] 0.946841119 0.951204442 0.955567765 0.959931089 0.964294412 0.968657735 #> [223] 0.973021058 0.977384381 0.981747704 0.986111027 0.990474351 0.994837674 #> [229] 0.999200997 1.003564320 1.007927643 1.012290966 1.016654289 1.021017612 #> [235] 1.025380936 1.029744259 1.034107582 1.038470905 1.042834228 1.047197551 #> [241] 1.051560874 1.055924197 1.060287521 1.064650844 1.069014167 1.073377490 #> [247] 1.077740813 1.082104136 1.086467459 1.090830782 1.095194106 1.099557429 #> [253] 1.103920752 1.108284075 1.112647398 1.117010721 1.121374044 1.125737368 #> [259] 1.130100691 1.134464014 1.138827337 1.143190660 1.147553983 1.151917306 #> [265] 1.156280629 1.160643953 1.165007276 1.169370599 1.173733922 1.178097245 #> [271] 1.182460568 1.186823891 1.191187214 1.195550538 1.199913861 1.204277184 #> [277] 1.208640507 1.213003830 1.217367153 1.221730476 1.226093800 1.230457123 #> [283] 1.234820446 1.239183769 1.243547092 1.247910415 1.252273738 1.256637061 #> [289] 1.261000385 1.265363708 1.269727031 1.274090354 1.278453677 1.282817000 #> [295] 1.287180323 1.291543646 1.295906970 1.300270293 1.304633616 1.308996939 #> [301] 1.313360262 1.317723585 1.322086908 1.326450232 1.330813555 1.335176878 #> [307] 1.339540201 1.343903524 1.348266847 1.352630170 1.356993493 1.361356817 #> [313] 1.365720140 1.370083463 1.374446786 1.378810109 1.383173432 1.387536755 #> [319] 1.391900078 1.396263402 1.400626725 1.404990048 1.409353371 1.413716694 #> [325] 1.418080017 1.422443340 1.426806664 1.431169987 1.435533310 1.439896633 #> [331] 1.444259956 1.448623279 1.452986602 1.457349925 1.461713249 1.466076572 #> [337] 1.470439895 1.474803218 1.479166541 1.483529864 1.487893187 1.492256510 #> [343] 1.496619834 1.500983157 1.505346480 1.509709803 1.514073126 1.518436449 #> [349] 1.522799772 1.527163095 1.531526419 1.535889742 1.540253065 1.544616388 #> [355] 1.548979711 1.553343034 1.557706357 1.562069681 1.566433004 1.570796327 #> [361] 1.575159650 1.579522973 1.583886296 1.588249619 1.592612942 1.596976266 #> [367] 1.601339589 1.605702912 1.610066235 1.614429558 1.618792881 1.623156204 #> [373] 1.627519527 1.631882851 1.636246174 1.640609497 1.644972820 1.649336143 #> [379] 1.653699466 1.658062789 1.662426113 1.666789436 1.671152759 1.675516082 #> [385] 1.679879405 1.684242728 1.688606051 1.692969374 1.697332698 1.701696021 #> [391] 1.706059344 1.710422667 1.714785990 1.719149313 1.723512636 1.727875959 #> [397] 1.732239283 1.736602606 1.740965929 1.745329252 1.749692575 1.754055898 #> [403] 1.758419221 1.762782545 1.767145868 1.771509191 1.775872514 1.780235837 #> [409] 1.784599160 1.788962483 1.793325806 1.797689130 1.802052453 1.806415776 #> [415] 1.810779099 1.815142422 1.819505745 1.823869068 1.828232391 1.832595715 #> [421] 1.836959038 1.841322361 1.845685684 1.850049007 1.854412330 1.858775653 #> [427] 1.863138977 1.867502300 1.871865623 1.876228946 1.880592269 1.884955592 #> [433] 1.889318915 1.893682238 1.898045562 1.902408885 1.906772208 1.911135531 #> [439] 1.915498854 1.919862177 1.924225500 1.928588823 1.932952147 1.937315470 #> [445] 1.941678793 1.946042116 1.950405439 1.954768762 1.959132085 1.963495408 #> [451] 1.967858732 1.972222055 1.976585378 1.980948701 1.985312024 1.989675347 #> [457] 1.994038670 1.998401994 2.002765317 2.007128640 2.011491963 2.015855286 #> [463] 2.020218609 2.024581932 2.028945255 2.033308579 2.037671902 2.042035225 #> [469] 2.046398548 2.050761871 2.055125194 2.059488517 2.063851840 2.068215164 #> [475] 2.072578487 2.076941810 2.081305133 2.085668456 2.090031779 2.094395102 #> [481] 2.098758426 2.103121749 2.107485072 2.111848395 2.116211718 2.120575041 #> [487] 2.124938364 2.129301687 2.133665011 2.138028334 2.142391657 2.146754980 #> [493] 2.151118303 2.155481626 2.159844949 2.164208272 2.168571596 2.172934919 #> [499] 2.177298242 2.181661565 2.186024888 2.190388211 2.194751534 2.199114858 #> [505] 2.203478181 2.207841504 2.212204827 2.216568150 2.220931473 2.225294796 #> [511] 2.229658119 2.234021443 2.238384766 2.242748089 2.247111412 2.251474735 #> [517] 2.255838058 2.260201381 2.264564704 2.268928028 2.273291351 2.277654674 #> [523] 2.282017997 2.286381320 2.290744643 2.295107966 2.299471290 2.303834613 #> [529] 2.308197936 2.312561259 2.316924582 2.321287905 2.325651228 2.330014551 #> [535] 2.334377875 2.338741198 2.343104521 2.347467844 2.351831167 2.356194490 #> [541] 2.360557813 2.364921136 2.369284460 2.373647783 2.378011106 2.382374429 #> [547] 2.386737752 2.391101075 2.395464398 2.399827721 2.404191045 2.408554368 #> [553] 2.412917691 2.417281014 2.421644337 2.426007660 2.430370983 2.434734307 #> [559] 2.439097630 2.443460953 2.447824276 2.452187599 2.456550922 2.460914245 #> [565] 2.465277568 2.469640892 2.474004215 2.478367538 2.482730861 2.487094184 #> [571] 2.491457507 2.495820830 2.500184153 2.504547477 2.508910800 2.513274123 #> [577] 2.517637446 2.522000769 2.526364092 2.530727415 2.535090739 2.539454062 #> [583] 2.543817385 2.548180708 2.552544031 2.556907354 2.561270677 2.565634000 #> [589] 2.569997324 2.574360647 2.578723970 2.583087293 2.587450616 2.591813939 #> [595] 2.596177262 2.600540585 2.604903909 2.609267232 2.613630555 2.617993878 #> [601] 2.622357201 2.626720524 2.631083847 2.635447171 2.639810494 2.644173817 #> [607] 2.648537140 2.652900463 2.657263786 2.661627109 2.665990432 2.670353756 #> [613] 2.674717079 2.679080402 2.683443725 2.687807048 2.692170371 2.696533694 #> [619] 2.700897017 2.705260341 2.709623664 2.713986987 2.718350310 2.722713633 #> [625] 2.727076956 2.731440279 2.735803603 2.740166926 2.744530249 2.748893572 #> [631] 2.753256895 2.757620218 2.761983541 2.766346864 2.770710188 2.775073511 #> [637] 2.779436834 2.783800157 2.788163480 2.792526803 2.796890126 2.801253449 #> [643] 2.805616773 2.809980096 2.814343419 2.818706742 2.823070065 2.827433388 #> [649] 2.831796711 2.836160034 2.840523358 2.844886681 2.849250004 2.853613327 #> [655] 2.857976650 2.862339973 2.866703296 2.871066620 2.875429943 2.879793266 #> [661] 2.884156589 2.888519912 2.892883235 2.897246558 2.901609881 2.905973205 #> [667] 2.910336528 2.914699851 2.919063174 2.923426497 2.927789820 2.932153143 #> [673] 2.936516466 2.940879790 2.945243113 2.949606436 2.953969759 2.958333082 #> [679] 2.962696405 2.967059728 2.971423052 2.975786375 2.980149698 2.984513021 #> [685] 2.988876344 2.993239667 2.997602990 3.001966313 3.006329637 3.010692960 #> [691] 3.015056283 3.019419606 3.023782929 3.028146252 3.032509575 3.036872898 #> [697] 3.041236222 3.045599545 3.049962868 3.054326191 3.058689514 3.063052837 #> [703] 3.067416160 3.071779484 3.076142807 3.080506130 3.084869453 3.089232776 #> [709] 3.093596099 3.097959422 3.102322745 3.106686069 3.111049392 3.115412715 #> [715] 3.119776038 3.124139361 3.128502684 3.132866007 3.137229330 3.141592654 #> [721] 3.145955977 3.150319300 3.154682623 3.159045946 3.163409269 3.167772592 #> [727] 3.172135915 3.176499239 3.180862562 3.185225885 3.189589208 3.193952531 #> [733] 3.198315854 3.202679177 3.207042501 3.211405824 3.215769147 3.220132470 #> [739] 3.224495793 3.228859116 3.233222439 3.237585762 3.241949086 3.246312409 #> [745] 3.250675732 3.255039055 3.259402378 3.263765701 3.268129024 3.272492347 #> [751] 3.276855671 3.281218994 3.285582317 3.289945640 3.294308963 3.298672286 #> [757] 3.303035609 3.307398933 3.311762256 3.316125579 3.320488902 3.324852225 #> [763] 3.329215548 3.333578871 3.337942194 3.342305518 3.346668841 3.351032164 #> [769] 3.355395487 3.359758810 3.364122133 3.368485456 3.372848779 3.377212103 #> [775] 3.381575426 3.385938749 3.390302072 3.394665395 3.399028718 3.403392041 #> [781] 3.407755365 3.412118688 3.416482011 3.420845334 3.425208657 3.429571980 #> [787] 3.433935303 3.438298626 3.442661950 3.447025273 3.451388596 3.455751919 #> [793] 3.460115242 3.464478565 3.468841888 3.473205211 3.477568535 3.481931858 #> [799] 3.486295181 3.490658504 3.495021827 3.499385150 3.503748473 3.508111797 #> [805] 3.512475120 3.516838443 3.521201766 3.525565089 3.529928412 3.534291735 #> [811] 3.538655058 3.543018382 3.547381705 3.551745028 3.556108351 3.560471674 #> [817] 3.564834997 3.569198320 3.573561643 3.577924967 3.582288290 3.586651613 #> [823] 3.591014936 3.595378259 3.599741582 3.604104905 3.608468228 3.612831552 #> [829] 3.617194875 3.621558198 3.625921521 3.630284844 3.634648167 3.639011490 #> [835] 3.643374814 3.647738137 3.652101460 3.656464783 3.660828106 3.665191429 #> [841] 3.669554752 3.673918075 3.678281399 3.682644722 3.687008045 3.691371368 #> [847] 3.695734691 3.700098014 3.704461337 3.708824660 3.713187984 3.717551307 #> [853] 3.721914630 3.726277953 3.730641276 3.735004599 3.739367922 3.743731246 #> [859] 3.748094569 3.752457892 3.756821215 3.761184538 3.765547861 3.769911184 #> [865] 3.774274507 3.778637831 3.783001154 3.787364477 3.791727800 3.796091123 #> [871] 3.800454446 3.804817769 3.809181092 3.813544416 3.817907739 3.822271062 #> [877] 3.826634385 3.830997708 3.835361031 3.839724354 3.844087678 3.848451001 #> [883] 3.852814324 3.857177647 3.861540970 3.865904293 3.870267616 3.874630939 #> [889] 3.878994263 3.883357586 3.887720909 3.892084232 3.896447555 3.900810878 #> [895] 3.905174201 3.909537524 3.913900848 3.918264171 3.922627494 3.926990817 #> [901] 3.931354140 3.935717463 3.940080786 3.944444110 3.948807433 3.953170756 #> [907] 3.957534079 3.961897402 3.966260725 3.970624048 3.974987371 3.979350695 #> [913] 3.983714018 3.988077341 3.992440664 3.996803987 4.001167310 4.005530633 #> [919] 4.009893956 4.014257280 4.018620603 4.022983926 4.027347249 4.031710572 #> [925] 4.036073895 4.040437218 4.044800541 4.049163865 4.053527188 4.057890511 #> [931] 4.062253834 4.066617157 4.070980480 4.075343803 4.079707127 4.084070450 #> [937] 4.088433773 4.092797096 4.097160419 4.101523742 4.105887065 4.110250388 #> [943] 4.114613712 4.118977035 4.123340358 4.127703681 4.132067004 4.136430327 #> [949] 4.140793650 4.145156973 4.149520297 4.153883620 4.158246943 4.162610266 #> [955] 4.166973589 4.171336912 4.175700235 4.180063559 4.184426882 4.188790205 #> [961] 4.193153528 4.197516851 4.201880174 4.206243497 4.210606820 4.214970144 #> [967] 4.219333467 4.223696790 4.228060113 4.232423436 4.236786759 4.241150082 #> [973] 4.245513405 4.249876729 4.254240052 4.258603375 4.262966698 4.267330021 #> [979] 4.271693344 4.276056667 4.280419991 4.284783314 4.289146637 4.293509960 #> [985] 4.297873283 4.302236606 4.306599929 4.310963252 4.315326576 4.319689899 #> [991] 4.324053222 4.328416545 4.332779868 4.337143191 4.341506514 4.345869837 #> [997] 4.350233161 4.354596484 4.358959807 4.363323130 4.367686453 4.372049776 #> [1003] 4.376413099 4.380776423 4.385139746 4.389503069 4.393866392 4.398229715 #> [1009] 4.402593038 4.406956361 4.411319684 4.415683008 4.420046331 4.424409654 #> [1015] 4.428772977 4.433136300 4.437499623 4.441862946 4.446226269 4.450589593 #> [1021] 4.454952916 4.459316239 4.463679562 4.468042885 4.472406208 4.476769531 #> [1027] 4.481132854 4.485496178 4.489859501 4.494222824 4.498586147 4.502949470 #> [1033] 4.507312793 4.511676116 4.516039440 4.520402763 4.524766086 4.529129409 #> [1039] 4.533492732 4.537856055 4.542219378 4.546582701 4.550946025 4.555309348 #> [1045] 4.559672671 4.564035994 4.568399317 4.572762640 4.577125963 4.581489286 #> [1051] 4.585852610 4.590215933 4.594579256 4.598942579 4.603305902 4.607669225 #> [1057] 4.612032548 4.616395872 4.620759195 4.625122518 4.629485841 4.633849164 #> [1063] 4.638212487 4.642575810 4.646939133 4.651302457 4.655665780 4.660029103 #> [1069] 4.664392426 4.668755749 4.673119072 4.677482395 4.681845718 4.686209042 #> [1075] 4.690572365 4.694935688 4.699299011 4.703662334 4.708025657 4.712388980 #> [1081] 4.716752304 4.721115627 4.725478950 4.729842273 4.734205596 4.738568919 #> [1087] 4.742932242 4.747295565 4.751658889 4.756022212 4.760385535 4.764748858 #> [1093] 4.769112181 4.773475504 4.777838827 4.782202150 4.786565474 4.790928797 #> [1099] 4.795292120 4.799655443 4.804018766 4.808382089 4.812745412 4.817108736 #> [1105] 4.821472059 4.825835382 4.830198705 4.834562028 4.838925351 4.843288674 #> [1111] 4.847651997 4.852015321 4.856378644 4.860741967 4.865105290 4.869468613 #> [1117] 4.873831936 4.878195259 4.882558582 4.886921906 4.891285229 4.895648552 #> [1123] 4.900011875 4.904375198 4.908738521 4.913101844 4.917465167 4.921828491 #> [1129] 4.926191814 4.930555137 4.934918460 4.939281783 4.943645106 4.948008429 #> [1135] 4.952371753 4.956735076 4.961098399 4.965461722 4.969825045 4.974188368 #> [1141] 4.978551691 4.982915014 4.987278338 4.991641661 4.996004984 5.000368307 #> [1147] 5.004731630 5.009094953 5.013458276 5.017821599 5.022184923 5.026548246 #> [1153] 5.030911569 5.035274892 5.039638215 5.044001538 5.048364861 5.052728185 #> [1159] 5.057091508 5.061454831 5.065818154 5.070181477 5.074544800 5.078908123 #> [1165] 5.083271446 5.087634770 5.091998093 5.096361416 5.100724739 5.105088062 #> [1171] 5.109451385 5.113814708 5.118178031 5.122541355 5.126904678 5.131268001 #> [1177] 5.135631324 5.139994647 5.144357970 5.148721293 5.153084617 5.157447940 #> [1183] 5.161811263 5.166174586 5.170537909 5.174901232 5.179264555 5.183627878 #> [1189] 5.187991202 5.192354525 5.196717848 5.201081171 5.205444494 5.209807817 #> [1195] 5.214171140 5.218534463 5.222897787 5.227261110 5.231624433 5.235987756 #> [1201] 5.240351079 5.244714402 5.249077725 5.253441049 5.257804372 5.262167695 #> [1207] 5.266531018 5.270894341 5.275257664 5.279620987 5.283984310 5.288347634 #> [1213] 5.292710957 5.297074280 5.301437603 5.305800926 5.310164249 5.314527572 #> [1219] 5.318890895 5.323254219 5.327617542 5.331980865 5.336344188 5.340707511 #> [1225] 5.345070834 5.349434157 5.353797480 5.358160804 5.362524127 5.366887450 #> [1231] 5.371250773 5.375614096 5.379977419 5.384340742 5.388704066 5.393067389 #> [1237] 5.397430712 5.401794035 5.406157358 5.410520681 5.414884004 5.419247327 #> [1243] 5.423610651 5.427973974 5.432337297 5.436700620 5.441063943 5.445427266 #> [1249] 5.449790589 5.454153912 5.458517236 5.462880559 5.467243882 5.471607205 #> [1255] 5.475970528 5.480333851 5.484697174 5.489060498 5.493423821 5.497787144 #> [1261] 5.502150467 5.506513790 5.510877113 5.515240436 5.519603759 5.523967083 #> [1267] 5.528330406 5.532693729 5.537057052 5.541420375 5.545783698 5.550147021 #> [1273] 5.554510344 5.558873668 5.563236991 5.567600314 5.571963637 5.576326960 #> [1279] 5.580690283 5.585053606 5.589416930 5.593780253 5.598143576 5.602506899 #> [1285] 5.606870222 5.611233545 5.615596868 5.619960191 5.624323515 5.628686838 #> [1291] 5.633050161 5.637413484 5.641776807 5.646140130 5.650503453 5.654866776 #> [1297] 5.659230100 5.663593423 5.667956746 5.672320069 5.676683392 5.681046715 #> [1303] 5.685410038 5.689773362 5.694136685 5.698500008 5.702863331 5.707226654 #> [1309] 5.711589977 5.715953300 5.720316623 5.724679947 5.729043270 5.733406593 #> [1315] 5.737769916 5.742133239 5.746496562 5.750859885 5.755223208 5.759586532 #> [1321] 5.763949855 5.768313178 5.772676501 5.777039824 5.781403147 5.785766470 #> [1327] 5.790129793 5.794493117 5.798856440 5.803219763 5.807583086 5.811946409 #> [1333] 5.816309732 5.820673055 5.825036379 5.829399702 5.833763025 5.838126348 #> [1339] 5.842489671 5.846852994 5.851216317 5.855579640 5.859942964 5.864306287 #> [1345] 5.868669610 5.873032933 5.877396256 5.881759579 5.886122902 5.890486225 #> [1351] 5.894849549 5.899212872 5.903576195 5.907939518 5.912302841 5.916666164 #> [1357] 5.921029487 5.925392811 5.929756134 5.934119457 5.938482780 5.942846103 #> [1363] 5.947209426 5.951572749 5.955936072 5.960299396 5.964662719 5.969026042 #> [1369] 5.973389365 5.977752688 5.982116011 5.986479334 5.990842657 5.995205981 #> [1375] 5.999569304 6.003932627 6.008295950 6.012659273 6.017022596 6.021385919 #> [1381] 6.025749243 6.030112566 6.034475889 6.038839212 6.043202535 6.047565858 #> [1387] 6.051929181 6.056292504 6.060655828 6.065019151 6.069382474 6.073745797 #> [1393] 6.078109120 6.082472443 6.086835766 6.091199089 6.095562413 6.099925736 #> [1399] 6.104289059 6.108652382 6.113015705 6.117379028 6.121742351 6.126105675 #> [1405] 6.130468998 6.134832321 6.139195644 6.143558967 6.147922290 6.152285613 #> [1411] 6.156648936 6.161012260 6.165375583 6.169738906 6.174102229 6.178465552 #> [1417] 6.182828875 6.187192198 6.191555521 6.195918845 6.200282168 6.204645491 #> [1423] 6.209008814 6.213372137 6.217735460 6.222098783 6.226462106 6.230825430 #> [1429] 6.235188753 6.239552076 6.243915399 6.248278722 6.252642045 6.257005368 #> [1435] 6.261368692 6.265732015 6.270095338 6.274458661 6.278821984 6.283185307"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielRings.html","id":null,"dir":"Reference","previous_headings":"","what":"Plot rings on a diel plot — dielRings","title":"Plot rings on a diel plot — dielRings","text":"Plot rings diel plot.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielRings.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plot rings on a diel plot — dielRings","text":"","code":"dielRings( names, starts, ends, cols = \"grey\", format = \"HHMM\", limits = c(1, 2), legend = T )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielRings.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plot rings on a diel plot — dielRings","text":"names Labels rings starts Start times rings HHMM string format ends End times rings HHMM string format cols Colours rings format Defaults HHMM limits Region dielPlot() plot rings. Defaults c(1,2) legend Boolean. Whether plot legend.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dolbear.html","id":null,"dir":"Reference","previous_headings":"","what":"Dolbear's law — dolbear","title":"Dolbear's law — dolbear","text":"dolbear1897;textualsonicscrewdriver first publish formula rate chirping crickets varies temperature, using tree cricket Oecanthus fultoni.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dolbear.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Dolbear's law — dolbear","text":"","code":"dolbear(n = NULL, t = NULL, species = \"Oecanthus fultoni\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dolbear.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Dolbear's law — dolbear","text":"n Chirps per minute t Temperature Celsius species Species use (default Oecanthus fultoni), NULL calculate species.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dolbear.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Dolbear's law — dolbear","text":"Data frame t n calculated matching species.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dolbear.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Dolbear's law — dolbear","text":"Subsequent research Dolbear others published additional formulae species: Oecanthus fultoni fulton1925sonicscrewdriver, Oecanthus rileyi walker1962sonicscrewdriver, Oecanthus alexanderi walker2010sonicscrewdriver, Oecanthus allardi allard1957sonicscrewdriver.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dolbear.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Dolbear's law — dolbear","text":"","code":"dolbear(n=6) #> species location m c min max source t n #> 1 Oecanthus fultoni Iowa 7.7879 -30.21 15 25 Fulton, 1925 4.649520 6 #> 2 Oecanthus fultoni Oregon 9.2007 -36.53 9 28 Fulton, 1925 4.622474 6 #> 3 Oecanthus fultoni Ohio 8.2080 -38.61 18 31 Walker, 1962 5.434942 6 dolbear(t=25) #> species location m c min max source t n #> 1 Oecanthus fultoni Iowa 7.7879 -30.21 15 25 Fulton, 1925 25 164.4875 #> 2 Oecanthus fultoni Oregon 9.2007 -36.53 9 28 Fulton, 1925 25 193.4875 #> 3 Oecanthus fultoni Ohio 8.2080 -38.61 18 31 Walker, 1962 25 166.5900"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_can_merge.html","id":null,"dir":"Reference","previous_headings":"","what":"Check if two annotations can be merged — .annotation_can_merge","title":"Check if two annotations can be merged — .annotation_can_merge","text":"Check two annotations can merged","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_can_merge.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check if two annotations can be merged — .annotation_can_merge","text":"","code":".annotation_can_merge(annotation1, annotation2, same.source = TRUE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_can_merge.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check if two annotations can be merged — .annotation_can_merge","text":"annotation1 Annotation object. annotation2 Annotation object. .source TRUE, annotations must source merged.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_can_merge.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check if two annotations can be merged — .annotation_can_merge","text":"TRUE annotations can merged, FALSE otherwise.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_check_overlap.html","id":null,"dir":"Reference","previous_headings":"","what":"Check if two annotations overlap or are continuous — .annotation_check_overlap","title":"Check if two annotations overlap or are continuous — .annotation_check_overlap","text":"Check two annotations overlap continuous","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_check_overlap.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check if two annotations overlap or are continuous — .annotation_check_overlap","text":"","code":".annotation_check_overlap(annotation1, annotation2, domain = \"time\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_check_overlap.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check if two annotations overlap or are continuous — .annotation_check_overlap","text":"annotation1 Annotation object. annotation2 Annotation object. domain Domain annotations, either \"time\", \"frequency\", \"\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_check_overlap.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check if two annotations overlap or are continuous — .annotation_check_overlap","text":"TRUE annotations overlap, FALSE otherwise.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_merge_overlapping.html","id":null,"dir":"Reference","previous_headings":"","what":"Combine overlapping annotations — .annotation_merge_overlapping","title":"Combine overlapping annotations — .annotation_merge_overlapping","text":"Combine overlapping annotations","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_merge_overlapping.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Combine overlapping annotations — .annotation_merge_overlapping","text":"","code":".annotation_merge_overlapping( annotation1, annotation2, domain = \"time\", same.source = TRUE )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_merge_overlapping.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Combine overlapping annotations — .annotation_merge_overlapping","text":"annotation1 Annotation object. annotation2 Annotation object. domain Domain annotations, either \"time\", \"frequency\", \"\". .source TRUE, annotations must source merged.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_merge_overlapping.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Combine overlapping annotations — .annotation_merge_overlapping","text":"new Annotation object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-spectrogram_maad_power.html","id":null,"dir":"Reference","previous_headings":"","what":"Helper function to convert a Wave-like object to scikit-maad spectrogram — .spectrogram_maad_power","title":"Helper function to convert a Wave-like object to scikit-maad spectrogram — .spectrogram_maad_power","text":"Helper function convert Wave-like object scikit-maad spectrogram","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-spectrogram_maad_power.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Helper function to convert a Wave-like object to scikit-maad spectrogram — .spectrogram_maad_power","text":"","code":".spectrogram_maad_power(object)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-spectrogram_maad_power.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Helper function to convert a Wave-like object to scikit-maad spectrogram — .spectrogram_maad_power","text":"object Wave WaveMC object (Tagged equivalent), spectrogram_maad object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-spectrogram_maad_power.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Helper function to convert a Wave-like object to scikit-maad spectrogram — .spectrogram_maad_power","text":"spectrogram_maad object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-spectrum_maad.html","id":null,"dir":"Reference","previous_headings":"","what":"Helper function to convert a Wave-like object to scikit-maad spectrum — .spectrum_maad","title":"Helper function to convert a Wave-like object to scikit-maad spectrum — .spectrum_maad","text":"Helper function convert Wave-like object scikit-maad spectrum","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-spectrum_maad.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Helper function to convert a Wave-like object to scikit-maad spectrum — .spectrum_maad","text":"","code":".spectrum_maad(object)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-spectrum_maad.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Helper function to convert a Wave-like object to scikit-maad spectrum — .spectrum_maad","text":"object Wave WaveMC object (Tagged equivalent), spectrum","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-spectrum_maad.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Helper function to convert a Wave-like object to scikit-maad spectrum — .spectrum_maad","text":"spectrum list","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dutyCycle.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate the duty cycle of a wave — dutyCycle","title":"Calculate the duty cycle of a wave — dutyCycle","text":"Proportion wave signal limit","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dutyCycle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate the duty cycle of a wave — dutyCycle","text":"","code":"dutyCycle(wave, limit = 0.1, output = \"unit\", normalise = TRUE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dutyCycle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate the duty cycle of a wave — dutyCycle","text":"wave Wave object limit Threshold consider signal output \"unit\" duty cycle range 0-1. percentage use \"percent\". normalise TRUE Wave normalised using tuneR","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dutyCycle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Calculate the duty cycle of a wave — dutyCycle","text":"numerical value duty cycle 0 1 (0 100% percentage output).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dutyCycle.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Calculate the duty cycle of a wave — dutyCycle","text":"","code":"wave <- tuneR::sine(2000) dc <- dutyCycle(wave) pc <- dutyCycle(wave, output=\"percent\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/emptyDiel.html","id":null,"dir":"Reference","previous_headings":"","what":"Create an empty diel plot — emptyDiel","title":"Create an empty diel plot — emptyDiel","text":"Create diel plot labels without sun altitude times day plotted.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/emptyDiel.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create an empty diel plot — emptyDiel","text":"","code":"emptyDiel(method = \"plotrix\", rot = pi)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/emptyDiel.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create an empty diel plot — emptyDiel","text":"method Plotting package use rot Rotation origin (defaults pi)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/emptyYearly.html","id":null,"dir":"Reference","previous_headings":"","what":"Create an empty yearly plot — emptyYearly","title":"Create an empty yearly plot — emptyYearly","text":"Create yearly plot labels without sun night duration plotted.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/emptyYearly.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create an empty yearly plot — emptyYearly","text":"","code":"emptyYearly(year = 2022, method = \"plotix\", rot = pi)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/emptyYearly.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create an empty yearly plot — emptyYearly","text":"year Year plot (allows leap years) method Plotting package use rot Rotation origin (defaults pi)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/entropyStats.html","id":null,"dir":"Reference","previous_headings":"","what":"Various measurements of frequency values for a Wave object — entropyStats","title":"Various measurements of frequency values for a Wave object — entropyStats","text":"Calculates peak, centre, bandwidth quality factor. quality factor (Q) calculated -3dB -10dB discussed Bennett-Clark (1999) doi:10.1080/09524622.1999.9753408.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/entropyStats.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Various measurements of frequency values for a Wave object — entropyStats","text":"","code":"entropyStats(wave)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/entropyStats.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Various measurements of frequency values for a Wave object — entropyStats","text":"wave Wave object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/entropyStats.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Various measurements of frequency values for a Wave object — entropyStats","text":"list spectral entropy types.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/entropyStats.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Various measurements of frequency values for a Wave object — entropyStats","text":"","code":"if (FALSE) { # \\dontrun{ entropyStats(sheep) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/filterWave.html","id":null,"dir":"Reference","previous_headings":"","what":"Apply a WaveFilter object to a Wave object — filterWave","title":"Apply a WaveFilter object to a Wave object — filterWave","text":"WaveFilter object object containing information necessary filterw function apply filter Wave object. designed allow pipe operator (either magrittr base R) used apply filters Wave pipeline.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/filterWave.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Apply a WaveFilter object to a Wave object — filterWave","text":"","code":"filterWave(w, filt, cl = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/filterWave.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Apply a WaveFilter object to a Wave object — filterWave","text":"w Wave object. filt Wave object selected filter applied. cl Optional. cluster specified, filter applied parallel.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/filterWave.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Apply a WaveFilter object to a Wave object — filterWave","text":"Supported filters include seewave package.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/frequencySound.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the frequency from wavelength and speed of sound — frequencySound","title":"Get the frequency from wavelength and speed of sound — frequencySound","text":"Calculates frequency sound wave given wavelength speed sound medium.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/frequencySound.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the frequency from wavelength and speed of sound — frequencySound","text":"","code":"frequencySound(wl, s = soundSpeed(medium = \"air\"))"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/frequencySound.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the frequency from wavelength and speed of sound — frequencySound","text":"wl Wavelength s Speed sound (defaults speed sound air)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/frequencySound.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the frequency from wavelength and speed of sound — frequencySound","text":"Frequency sound Hertz","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/frequencySound.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get the frequency from wavelength and speed of sound — frequencySound","text":"","code":"f <- frequencySound(wl=100, s=343)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/frequencyStats.html","id":null,"dir":"Reference","previous_headings":"","what":"Various measurements of frequency values for a Wave object — frequencyStats","title":"Various measurements of frequency values for a Wave object — frequencyStats","text":"Calculates peak, centre, bandwidth quality factor. quality factor (Q) calculated -3dB -10dB discussed Bennett-Clark (1999) .","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/frequencyStats.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Various measurements of frequency values for a Wave object — frequencyStats","text":"","code":"frequencyStats(wave, wave_spec = NULL, warn = TRUE, lowcut = 1, plot = FALSE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/frequencyStats.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Various measurements of frequency values for a Wave object — frequencyStats","text":"wave Wave object wave_spec precomputed spectrum (optional, present generated) warn TRUE provides warnings values consistent lowcut Frequency (kHz) values ignored. plot TRUE displays values","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateNoise.html","id":null,"dir":"Reference","previous_headings":"","what":"Add noise to a Wave like object — generateNoise","title":"Add noise to a Wave like object — generateNoise","text":"Adding noise Wave like object allows testing robustness automated identification algorithms noise.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateNoise.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add noise to a Wave like object — generateNoise","text":"","code":"generateNoise( wave, noise = c(\"white\"), noise.add = FALSE, noise.ratio = 0.5, noise.ref = \"file\", output = \"list\" )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateNoise.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add noise to a Wave like object — generateNoise","text":"wave Object add noise (Wave, WaveMC, Tagged versions), list objects. noise Vector noise add (unif, gaussian, white, pink, power, red) noise.add TRUE noise sources added wave. FALSE separate outputs created noise source. noise.ratio Ratio maximum noise amplitude maximum amplitude wave. noise.ref Reference maximum noise.ratio. \"max\" maximum amplitude, \"file\" maximum amplitude wave. output TODO: implemented?","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateNoise.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add noise to a Wave like object — generateNoise","text":"list Wave objects required noise added.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateTimeMask.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate time masked Wave-like objects — generateTimeMask","title":"Generate time masked Wave-like objects — generateTimeMask","text":"Given Wave-like object (list Wave-like objects), generate new Wave-like objects time masking.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateTimeMask.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate time masked Wave-like objects — generateTimeMask","text":"","code":"generateTimeMask(wave, method = \"squarewave\", dutyCycle = 0.95, n.periods = 10)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateTimeMask.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate time masked Wave-like objects — generateTimeMask","text":"wave Wave-like object (list Wave-like objects). method method use time masking (one \"squarewave\", \"random). dutyCycle duty cycle output. value 0.95 means 5% time masked. n.periods number waves generate squarewave method.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateTimeShift.html","id":null,"dir":"Reference","previous_headings":"","what":"Generated time-shifted versions of a Wave-like object — generateTimeShift","title":"Generated time-shifted versions of a Wave-like object — generateTimeShift","text":"Given Wave-like object (list Wave-like objects), function generates time-shifted versions object. time-shifted versions generated adding constant amount time start end object. achieved either inserting silence truncating object original length, rotating audio within object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateTimeShift.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generated time-shifted versions of a Wave-like object — generateTimeShift","text":"","code":"generateTimeShift( wave, type = \"silent\", amount = c(1, 2), where = \"start\", output = \"list\" )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateTimeShift.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generated time-shifted versions of a Wave-like object — generateTimeShift","text":"wave Wave-like object list Wave-like objects. type type time-shift apply. Either \"silent\" \"rotate\". amount Vector amount time shift (seconds). insert silence type \"silent\". output Return list.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateTimeShift.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generated time-shifted versions of a Wave-like object — generateTimeShift","text":"Wave-like object list Wave-like objects.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/getMaad.html","id":null,"dir":"Reference","previous_headings":"","what":"Import scikit-maad — getMaad","title":"Import scikit-maad — getMaad","text":"Imports scikit-maad object R. allows reuse object function calls.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/getMaad.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Import scikit-maad — getMaad","text":"","code":"getMaad()"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/gs_transcribe.html","id":null,"dir":"Reference","previous_headings":"","what":"Google Speech API Transcribe — gs_transcribe","title":"Google Speech API Transcribe — gs_transcribe","text":"Wrapper around various Google packages simplify speech transcription.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/gs_transcribe.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Google Speech API Transcribe — gs_transcribe","text":"","code":"gs_transcribe(filename, bucket = NULL, ...)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/gs_transcribe.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Google Speech API Transcribe — gs_transcribe","text":"filename Path file analysis bucket Storage bucket Google Cloud larger files ... Additional arguments pass gl_speech()","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/gs_transcribe.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Google Speech API Transcribe — gs_transcribe","text":"gs_transcribe object containing details transcription","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/gs_transcribe.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Google Speech API Transcribe — gs_transcribe","text":"","code":"if (FALSE) { # \\dontrun{ gs_transcribe(\"demo.wav\") } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/humanBytes.html","id":null,"dir":"Reference","previous_headings":"","what":"Converts bytes in human readable form — humanBytes","title":"Converts bytes in human readable form — humanBytes","text":"Given input bytes calculates result sensible output unit (e.g. MB, GB, PB).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/humanBytes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Converts bytes in human readable form — humanBytes","text":"","code":"humanBytes(S)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/humanBytes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Converts bytes in human readable form — humanBytes","text":"S Number bytes","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/humanBytes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Converts bytes in human readable form — humanBytes","text":"String human readable format","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/humanTime.html","id":null,"dir":"Reference","previous_headings":"","what":"Converts time to human readable form — humanTime","title":"Converts time to human readable form — humanTime","text":"Given input bytes calculates result sensible output unit (e.g. minutes, hours).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/humanTime.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Converts time to human readable form — humanTime","text":"","code":"humanTime(S, unit = \"seconds\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/humanTime.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Converts time to human readable form — humanTime","text":"S Time convert unit unit unit time convert","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/humanTime.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Converts time to human readable form — humanTime","text":"String human readable format","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/jitter.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate the jitter in a Wave object — jitter","title":"Calculate the jitter in a Wave object — jitter","text":"Jitter measure variability periods waveform. Relative jitter scaled jitter analysed waveform.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/jitter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate the jitter in a Wave object — jitter","text":"","code":"jitter(wave, method = \"absolute\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/jitter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate the jitter in a Wave object — jitter","text":"wave Wave object method One \"absolute\" \"relative\"","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/jitter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Calculate the jitter in a Wave object — jitter","text":"vector zero crossing locations","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/jitter.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Calculate the jitter in a Wave object — jitter","text":"","code":"if (FALSE) { # \\dontrun{ jitter(sheep, method=\"absolute\") jitter(sheep, method=\"relative\") } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelPadding.html","id":null,"dir":"Reference","previous_headings":"","what":"Pad labels with interval — labelPadding","title":"Pad labels with interval — labelPadding","text":"Takes labels Google Speech API transcript pads time specified number seconds.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelPadding.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pad labels with interval — labelPadding","text":"","code":"labelPadding(t, pad = 0.5, max_t = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelPadding.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pad labels with interval — labelPadding","text":"t Transcript Google Speech API pad Amount time (seconds) add start end max_t Optional. duration file, padding exceed length file.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelPadding.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pad labels with interval — labelPadding","text":"modified Google Speech API transcript object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelPadding.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Pad labels with interval — labelPadding","text":"","code":"if (FALSE) { # \\dontrun{ labelPadding(t, pad=2, max_t=duration(wave)) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelReduction.html","id":null,"dir":"Reference","previous_headings":"","what":"Combines labels which overlap into single continuous regions — labelReduction","title":"Combines labels which overlap into single continuous regions — labelReduction","text":"Takes labels Google Speech API transcript combines overlapping labels.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelReduction.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Combines labels which overlap into single continuous regions — labelReduction","text":"","code":"labelReduction(t)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelReduction.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Combines labels which overlap into single continuous regions — labelReduction","text":"t Transcript Google Speech API","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelReduction.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Combines labels which overlap into single continuous regions — labelReduction","text":"list containing start end times speech containing regions","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelReduction.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Combines labels which overlap into single continuous regions — labelReduction","text":"","code":"if (FALSE) { # \\dontrun{ labelReduction(t) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_acoustic_complexity_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute the acoustic complexity index using scikit-maad — maad_acoustic_complexity_index","title":"Compute the acoustic complexity index using scikit-maad — maad_acoustic_complexity_index","text":"ACI depends duration spectrogram derivation signal normalized sum signal. Thus, background noise high due high acoustic activity normalization sum signal reduced ACI. ACI low acoustic activity high acoustic activity continuous background noise. ACI high acoustic activity medium, sounds well background noise.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_acoustic_complexity_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute the acoustic complexity index using scikit-maad — maad_acoustic_complexity_index","text":"","code":"maad_acoustic_complexity_index(object, maad = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_acoustic_complexity_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute the acoustic complexity index using scikit-maad — maad_acoustic_complexity_index","text":"object Wave object spectrogram_maad object generated maad_spectrogram. Wave-like object provided, spectrogram calculated using default parameters. maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_acoustic_complexity_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute the acoustic complexity index using scikit-maad — maad_acoustic_complexity_index","text":"List comprising: ACI_xx Acoustic Complexity Index. ACI_per_bin Acoustic Complexity Index. ACI_sum Sum ACI value per frequency bin (Common definition)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_acoustic_complexity_index.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Compute the acoustic complexity index using scikit-maad — maad_acoustic_complexity_index","text":"addition documentation see https://scikit-maad.github.io/generated/maad.features.temporal_acoustic_complexity_index.html pieretti2011sonicscrewdriver.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_frequency_entropy.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute the frequency entropy using scikit-maad — maad_frequency_entropy","title":"Compute the frequency entropy using scikit-maad — maad_frequency_entropy","text":"spectral entropy signal measures energy dispersion along frequencies. Low values indicates concentration energy around narrow frequency band. DC value removed processing large peak f=0Hz lower entropy signal.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_frequency_entropy.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute the frequency entropy using scikit-maad — maad_frequency_entropy","text":"","code":"maad_frequency_entropy(object, compatibility = \"QUT\", maad = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_frequency_entropy.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute the frequency entropy using scikit-maad — maad_frequency_entropy","text":"object Wave object spectrogram_maad object generated maad_spectrogram. Wave-like object provided, spectrogram calculated using default parameters. compatibility One \"QUT\" qutsonicscrewdriver \"seewave\" seewave2008sonicscrewdriver. Default \"QUT\". maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_frequency_entropy.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute the frequency entropy using scikit-maad — maad_frequency_entropy","text":"List comprising: Hf Frequency entropy. Ht_per_bin Temporal entropy per frequency bin.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_frequency_entropy.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Compute the frequency entropy using scikit-maad — maad_frequency_entropy","text":"addition documentation see https://scikit-maad.github.io/generated/maad.features.frequency_entropy.html","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_number_of_peaks.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute the number of peaks using scikit-maad — maad_number_of_peaks","title":"Compute the number of peaks using scikit-maad — maad_number_of_peaks","text":"Count number frequency peaks mean spectrum. function adapted function fpeaks R package Seewave seewave2008sonicscrewdriver.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_number_of_peaks.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute the number of peaks using scikit-maad — maad_number_of_peaks","text":"","code":"maad_number_of_peaks( object, mode = \"dB\", min_peak_val = NULL, min_freq_dist = 200, slopes = c(1, 1), prominence = 0, maad = NULL )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_number_of_peaks.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute the number of peaks using scikit-maad — maad_number_of_peaks","text":"object Wave object spectrogram_maad object generated maad_spectrogram. Wave-like object provided, spectrogram calculated using default parameters. mode One \"dB\", \"linear\". min_peak_val peaks threshold considered. min_freq_dist Frequency threshold parameter (Hz). frequency difference two successive peaks less threshold, peak highest amplitude kept . slopes Refers amplitude slopes peak. first value left slope second value right slope. peaks higher slopes threshold values kept. prominence first element minimal prominence second element maximal prominence. single number provided interpreted minimal value, maximal value used. maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_number_of_peaks.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute the number of peaks using scikit-maad — maad_number_of_peaks","text":"Numeric number peaks","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_number_of_peaks.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Compute the number of peaks using scikit-maad — maad_number_of_peaks","text":"addition documentation see https://scikit-maad.github.io/generated/maad.features.number_of_peaks.html","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectral_activity.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute the spectral activity using scikit-maad — maad_spectral_activity","title":"Compute the spectral activity using scikit-maad — maad_spectral_activity","text":"Acoustic activity corresponds portion spectrogram threshold frequency per frequency along time axis towsey2017sonicscrewdriver.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectral_activity.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute the spectral activity using scikit-maad — maad_spectral_activity","text":"","code":"maad_spectral_activity(object, dB_threshold = 6, maad = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectral_activity.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute the spectral activity using scikit-maad — maad_spectral_activity","text":"object Wave object spectrogram_maad object. dB_threshold dB threshold activity (default = 6). maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectral_activity.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute the spectral activity using scikit-maad — maad_spectral_activity","text":"function computes frequency bin: ACTfract Proportion (fraction) points threshold. ACTcount Total number points threshold. ACTmean Mean value (dB) portion signal threshold.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectral_entropy.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute the frequency entropy using scikit-maad — maad_spectral_entropy","title":"Compute the frequency entropy using scikit-maad — maad_spectral_entropy","text":"Compute different entropies based average spectrum, variance, maxima.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectral_entropy.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute the frequency entropy using scikit-maad — maad_spectral_entropy","text":"","code":"maad_spectral_entropy(object, flim = NULL, maad = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectral_entropy.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute the frequency entropy using scikit-maad — maad_spectral_entropy","text":"object Wave object spectrogram_maad object generated maad_spectrogram. Wave-like object provided, spectrogram calculated using default parameters. flim numeric vector length 2 specifying frequency limits entropy calculation. maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectral_entropy.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute the frequency entropy using scikit-maad — maad_spectral_entropy","text":"List comprising: EAS Entropy Average Spectrum. ECU Entropy spectral variance (along time axis frequency). ECV Entropy Coefficient Variation (along time axis frequency). EPS Entropy spectral maxima (peaks). EPS_KURT Kurtosis spectral maxima. EPS_SKEW Skewness spectral maxima.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectral_entropy.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Compute the frequency entropy using scikit-maad — maad_spectral_entropy","text":"addition documentation see https://scikit-maad.github.io/generated/maad.features.spectral_entropy.html","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectrogram.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute a spectrogram of a sound wave using scikit-maad — maad_spectrogram","title":"Compute a spectrogram of a sound wave using scikit-maad — maad_spectrogram","text":"wrapper function maad.sound.spectrogram function scikit-maad package Python. computes spectrogram sound wave. usage details provided https://maad.readthedocs.io/en/latest/maad.sound.html#maad.sound.spectrogram.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectrogram.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute a spectrogram of a sound wave using scikit-maad — maad_spectrogram","text":"","code":"maad_spectrogram(wave, mode = \"power\", ..., maad = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectrogram.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute a spectrogram of a sound wave using scikit-maad — maad_spectrogram","text":"wave Wave object mode type spectrogram compute. Options \"power\", \"amplitude\" \"complex\". Default \"power\". ... Additional arguments pass maad.sound.spectrogram. maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectrogram.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute a spectrogram of a sound wave using scikit-maad — maad_spectrogram","text":"Generically spectrogram_maad object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectrum.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute a spectrum of a sound wave using scikit-maad — maad_spectrum","title":"Compute a spectrum of a sound wave using scikit-maad — maad_spectrum","text":"wrapper function maad.sound.spectrum function. computes spectrum sound wave. usage details provided https://maad.readthedocs.io/en/latest/maad.sound.html#maad.sound.spectrum.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectrum.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute a spectrum of a sound wave using scikit-maad — maad_spectrum","text":"","code":"maad_spectrum(wave, ..., maad = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectrum.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute a spectrum of a sound wave using scikit-maad — maad_spectrum","text":"wave Wave object ... Additional arguments pass maad.sound.spectrum. maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectrum.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute a spectrum of a sound wave using scikit-maad — maad_spectrum","text":"list comprising: pxx Power spectral density estimate. f_idx Index sample frequencies.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_activity.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute the acoustic activity index using scikit-maad — maad_temporal_activity","title":"Compute the acoustic activity index using scikit-maad — maad_temporal_activity","text":"addition documentation see https://scikit-maad.github.io/generated/maad.features.temporal_activity.html towsey2013sonicscrewdriver.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_activity.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute the acoustic activity index using scikit-maad — maad_temporal_activity","text":"","code":"maad_temporal_activity( wave, dB_threshold = 3, mode = \"fast\", Nt = 512, maad = NULL )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_activity.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute the acoustic activity index using scikit-maad — maad_temporal_activity","text":"wave Wave object. dB_threshold dB threshold activity (default = 3). mode Mode envelope calculation. Can \"fast\" \"Hilbert\". Nt Size frame. largest, highest approximation. maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_activity.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute the acoustic activity index using scikit-maad — maad_temporal_activity","text":"List calculated values, comprising: ACTfrac fraction)points threshold frequency bin. ACTcount total number points threshold frequency bin. ACTmean mean value (dB) portion signal threshold.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_entropy.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute the temporal entropy using scikit-maad — maad_temporal_entropy","title":"Compute the temporal entropy using scikit-maad — maad_temporal_entropy","text":"addition documentation see https://scikit-maad.github.io/generated/maad.features.temporal_entropy.html.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_entropy.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute the temporal entropy using scikit-maad — maad_temporal_entropy","text":"","code":"maad_temporal_entropy( wave, compatibility = \"QUT\", mode = \"fast\", Nt = 512, maad = NULL )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_entropy.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute the temporal entropy using scikit-maad — maad_temporal_entropy","text":"wave Wave object. compatibility One \"QUT\" qutsonicscrewdriver, \"seewave\" seewave2008sonicscrewdriver. mode Mode envelope calculation. Can \"fast\" \"hilbert\". Nt Size frame. largest, highest approximation. maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_entropy.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute the temporal entropy using scikit-maad — maad_temporal_entropy","text":"Numeric entropy envelope.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_events.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute the acoustic event index using scikit-maad — maad_temporal_events","title":"Compute the acoustic event index using scikit-maad — maad_temporal_events","text":"acoustic event corresponds period signal threshold. acoustic event short (list one point rejectDuration None) long (duration entire audio). Two acoustic events separated period low audio signal (.e. threshold).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_events.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute the acoustic event index using scikit-maad — maad_temporal_events","text":"","code":"maad_temporal_events( wave, dB_threshold = 3, rejectDuration = 0.1, mode = \"fast\", Nt = 512, maad = NULL )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_events.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute the acoustic event index using scikit-maad — maad_temporal_events","text":"wave Wave object. dB_threshold dB threshold activity (default = 3). rejectDuration Duration silence reject acoustic event (default = 0.1). mode Mode envelope calculation. Can \"fast\" \"Hilbert\". Nt Size frame. larger, highest approximation. maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_events.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute the acoustic event index using scikit-maad — maad_temporal_events","text":"List calculated values, comprising: EVTfrac fraction points threshold frequency bin. EVTcount total number points threshold frequency bin. EVTmean mean value (dB) portion signal threshold. EVN logical vector matrix 1 corresponding event position.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_events.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Compute the acoustic event index using scikit-maad — maad_temporal_events","text":"addition documentation see https://scikit-maad.github.io/generated/maad.features.temporal_events.html towsey2013sonicscrewdriver qutsonicscrewdriver.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_median.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute the temporal envelope median using scikit-maad — maad_temporal_median","title":"Compute the temporal envelope median using scikit-maad — maad_temporal_median","text":"addition documentation see https://scikit-maad.github.io/generated/maad.features.temporal_median.html.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_median.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute the temporal envelope median using scikit-maad — maad_temporal_median","text":"","code":"maad_temporal_median(wave, mode = \"fast\", Nt = 512, maad = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_median.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute the temporal envelope median using scikit-maad — maad_temporal_median","text":"wave Wave object. mode Mode envelope calculation. Can \"fast\" \"hilbert\". Nt Size frame. largest, highest approximation. maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_median.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute the temporal envelope median using scikit-maad — maad_temporal_median","text":"Numeric median envelope.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/map2RGB.html","id":null,"dir":"Reference","previous_headings":"","what":"Map three vectors to RGB — map2RGB","title":"Map three vectors to RGB — map2RGB","text":"Maps three vectors equal length RGB use false-colour index spectrograms","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/map2RGB.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Map three vectors to RGB — map2RGB","text":"","code":"map2RGB(red, green, blue)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/map2RGB.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Map three vectors to RGB — map2RGB","text":"red red channel vector green green channel vector blue blue channel vector","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/map2RGB.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Map three vectors to RGB — map2RGB","text":"vector RGB values","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/naturalFrequency.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate the natural frequency — naturalFrequency","title":"Calculate the natural frequency — naturalFrequency","text":"Calculates natural frequency given inductance, capacitance resistance. acoustic case inductance inertia mass, capacitance elasticity (bulk modulus) resistance composed air resistance related quantities. units SI.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/naturalFrequency.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate the natural frequency — naturalFrequency","text":"","code":"naturalFrequency(L, C = \"default\", R)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/naturalFrequency.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate the natural frequency — naturalFrequency","text":"L Inductance C Capacitance, default IUPAC standard pressure. R Resistance","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/naturalFrequency.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Calculate the natural frequency — naturalFrequency","text":"isothermal compression, bulk modulus equal pressure. default value C therefore IUPAC standard pressure.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/naturalFrequency.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Calculate the natural frequency — naturalFrequency","text":"","code":"naturalFrequency(L=20,R=0.5) #> [1] 0.002950812 naturalFrequency(L=20,C=1/4,R=0.5) #> [1] 0.07114845"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/normalise.html","id":null,"dir":"Reference","previous_headings":"","what":"Normalise a Wave object — normalise","title":"Normalise a Wave object — normalise","text":"Similar normalize() tuneR package automatically identifies unit parameter.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/normalise.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Normalise a Wave object — normalise","text":"","code":"normalise(wave, unit = NULL, ...)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/normalise.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Normalise a Wave object — normalise","text":"wave Wave WaveMC object unit null behaves normalize() tuneR, null unit automatically identified. ... Additional arguments passed normalize() tuneR","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/normalise.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Normalise a Wave object — normalise","text":"Normalised Wave WaveMC object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ntd.html","id":null,"dir":"Reference","previous_headings":"","what":"Natural Time Domain — ntd","title":"Natural Time Domain — ntd","text":"Runs function wave outputs values Natural Time Domain (see Varotsos, Sarlis & Skordas(2011) doi:10.1007/978-3-642-16449-1).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ntd.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Natural Time Domain — ntd","text":"","code":"ntd(wave, events, FUN, normalise = FALSE, argument = \"wave\", ...)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ntd.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Natural Time Domain — ntd","text":"wave Wave object containing pulses events Onset detected events, e.g. pulseDetection() FUN function run normalise TRUE output probability density argument \"wave\" supplies weave object function, \"vector\" supplies left channel numeric vector. ... Additional arguments FUN","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ntd.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Natural Time Domain — ntd","text":"list outputs form applied function","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/parseFilename.html","id":null,"dir":"Reference","previous_headings":"","what":"Parse a filename — parseFilename","title":"Parse a filename — parseFilename","text":"Attempts extract meaningful information filename, typically date time recording started.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/parseFilename.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Parse a filename — parseFilename","text":"","code":"parseFilename(file, format = NULL, timezone = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/parseFilename.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Parse a filename — parseFilename","text":"file filename (list filenames). format Optionally force given format (see Details). NULL (default) attempt made automatically detect format file. \"match\" list filenames given attempt made find format matches files. may give incorrect results filename ambiguous (see Details). timezone Optionally set timezone.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/parseFilename.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Parse a filename — parseFilename","text":"list file, type match, datetime. possible determine additional properties files, added list.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/parseFilename.html","id":"determining-the-format","dir":"Reference","previous_headings":"","what":"Determining the format","title":"Parse a filename — parseFilename","text":"sometimes impossible accurately determine format filename, e.g. eight-digit 'AudioMoth HEX' contains numbers confused YYYYMMDD format. list filenames given \"match\" format specified effort made determine likely format applies filenames.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/parseFilename.html","id":"supported-formats","dir":"Reference","previous_headings":"","what":"Supported formats","title":"Parse a filename — parseFilename","text":"AudioMoth - newer format AudioMoth devices consists standard YYYYMMDD_HHMMSS.wav format. Specifying 'AudioMoth' forces call audiomoth() function seewave package seewave2008sonicscrewdriver. AudioMoth HEX - Older format AudioMoth devices consisting eight hexadecimal characters. Conversion handled call seewave::audiomoth(). timestamp - standard date-time format. Uses R standard origin 1970-01-01 00:00:00 UTC. Wildlife Acoustics SM2 - Can also used Wildlife Acoustics SM4 devices. Conversion handled call seewave::songmeter(). Wildlife Acoustics SM3 - Conversion handled call seewave::songmeter(). YYYYMMDD_HHMMSS - standard date-time format.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/parseFilename.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Parse a filename — parseFilename","text":"","code":"parseFilename(\"5E90A4D4.wav\") #> $filename #> [1] \"5E90A4D4.wav\" #> #> $match #> [1] \"AudioMoth HEX\" #> #> $datetime #> [1] \"2020-04-10 16:54:44 UTC\" #>"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pd_dietrich2004.html","id":null,"dir":"Reference","previous_headings":"","what":"Pulse detection using Dietrich (2004) — pd_dietrich2004","title":"Pulse detection using Dietrich (2004) — pd_dietrich2004","text":"Detects pulses Wave using method described Dietrich et al (2004) doi:10.1016/j.patcog.2004.04.004.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pd_dietrich2004.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pulse detection using Dietrich (2004) — pd_dietrich2004","text":"","code":"pd_dietrich2004( wave, U = 120, gamma = 0.05, alpha = 1.4, scaling = 32, V = 480, psi = 1 )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pd_dietrich2004.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pulse detection using Dietrich (2004) — pd_dietrich2004","text":"wave Wave object U Window length gamma Gamma alpha Alpha scaling Scaling V V Window length psi Psi","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pd_dietrich2004.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pulse detection using Dietrich (2004) — pd_dietrich2004","text":"list input values plus onset offset times pulses","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pd_simple.html","id":null,"dir":"Reference","previous_headings":"","what":"Simplified pulse detection using Dietrich (2004) — pd_simple","title":"Simplified pulse detection using Dietrich (2004) — pd_simple","text":"Detects pulses Wave.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pd_simple.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Simplified pulse detection using Dietrich (2004) — pd_simple","text":"","code":"pd_simple( wave, U = 120, gamma = 0.05, alpha = 1.4, scaling = 32, V = 480, psi = 1 )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pd_simple.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Simplified pulse detection using Dietrich (2004) — pd_simple","text":"wave Wave object U Window length gamma Gamma alpha Alpha scaling Scaling V V Window length psi Psi","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/plus-PseudoWave-numeric-method.html","id":null,"dir":"Reference","previous_headings":"","what":"PseudoWave scalar addition — +,PseudoWave,numeric-method","title":"PseudoWave scalar addition — +,PseudoWave,numeric-method","text":"PseudoWave scalar addition","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/plus-PseudoWave-numeric-method.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"PseudoWave scalar addition — +,PseudoWave,numeric-method","text":"","code":"# S4 method for class 'PseudoWave,numeric' e1 + e2"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/plus-PseudoWave-numeric-method.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"PseudoWave scalar addition — +,PseudoWave,numeric-method","text":"e1 Input 1 e2 Input 2","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/plus-numeric-PseudoWave-method.html","id":null,"dir":"Reference","previous_headings":"","what":"Numeric addition by PseudoWave — +,numeric,PseudoWave-method","title":"Numeric addition by PseudoWave — +,numeric,PseudoWave-method","text":"Numeric addition PseudoWave","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/plus-numeric-PseudoWave-method.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Numeric addition by PseudoWave — +,numeric,PseudoWave-method","text":"","code":"# S4 method for class 'numeric,PseudoWave' e1 + e2"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/plus-numeric-PseudoWave-method.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Numeric addition by PseudoWave — +,numeric,PseudoWave-method","text":"e1 Input 1 e2 Input 2","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pseudoWave.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a PseudoWave object — pseudoWave","title":"Create a PseudoWave object — pseudoWave","text":"function used create PseudoWave object can used generate Wave object operated .","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pseudoWave.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a PseudoWave object — pseudoWave","text":"","code":"pseudoWave( type = NA_character_, subtype = NA_character_, scale = 1, offset = 0, seed = 1, params = list() )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pseudoWave.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a PseudoWave object — pseudoWave","text":"type Type PseudoWave (e.g. \"noise\", \"sine\") subtype Subtype PseudoWave (e.g. \"white\" type \"noise\") scale Wave channels multiplied value offset value added Wave channels seed Random seed reproducible output. NA params List additional parameters pass generating function","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pseudoWave.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a PseudoWave object — pseudoWave","text":"PseudoWave object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pseudoWave.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a PseudoWave object — pseudoWave","text":"","code":"pw <- pseudoWave(\"noise\", \"white\") pw <- pseudoWave(\"sine\", params=list(\"f0\"=440))"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulse.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a single pulse — pulse","title":"Generate a single pulse — pulse","text":"Generate single pulse, either Dirac pulse (Dirac delta) square pulse.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulse.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a single pulse — pulse","text":"","code":"pulse( type = \"dirac\", leading = 22050, pulse.length = 1, duration = samp.rate, samp.rate = 44100, bit = 1, pcm = FALSE, stereo = FALSE, output = \"Wave\", invert = FALSE )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulse.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a single pulse — pulse","text":"type Either \"dirac\" \"square\". leading number samples pulse. pulse.length number samples pulse (\"square\"). duration total number samples generated. samp.rate sample rate. bit bit depth. pcm Whether Wave generated PCM (see tuneR). stereo Whether Wave generated stereo. output output format (\"Wave\"). invert Whether invert pulse.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulse.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a single pulse — pulse","text":"Specified output.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulseDetection.html","id":null,"dir":"Reference","previous_headings":"","what":"Pulse detection — pulseDetection","title":"Pulse detection — pulseDetection","text":"Detects pulses Wave, defaults using Dietrich (2004).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulseDetection.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pulse detection — pulseDetection","text":"","code":"pulseDetection(wave, method = \"simple\", ...)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulseDetection.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pulse detection — pulseDetection","text":"wave Wave object containing pulses method method use pulse detection ... arguments pass pulse detection function","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulseIntervals.html","id":null,"dir":"Reference","previous_headings":"","what":"Pulse intervals — pulseIntervals","title":"Pulse intervals — pulseIntervals","text":"Used locate area pulses results pulseDetection().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulseIntervals.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pulse intervals — pulseIntervals","text":"","code":"pulseIntervals(pulses, nsd = 2)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulseIntervals.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pulse intervals — pulseIntervals","text":"pulses result pulseDetection. nsd number standard deviations sid mean pulse interval discard","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulseIntervals.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pulse intervals — pulseIntervals","text":"list onset offset times pulses","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pythonInstall.html","id":null,"dir":"Reference","previous_headings":"","what":"Install sonicscrewdriver Python environment — pythonInstall","title":"Install sonicscrewdriver Python environment — pythonInstall","text":"function installs scikit-maad sonicscrewdriver environment using reticulate.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pythonInstall.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install sonicscrewdriver Python environment — pythonInstall","text":"","code":"pythonInstall(unattended = FALSE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pythonInstall.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install sonicscrewdriver Python environment — pythonInstall","text":"unattended TRUE function prompt user install environment non-interactive session.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pythonInstall.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install sonicscrewdriver Python environment — pythonInstall","text":"","code":"if (FALSE) { # \\dontrun{ maadInstall() maadInstall(unattended=TRUE) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarPower.html","id":null,"dir":"Reference","previous_headings":"","what":"The radar equation — radarPower","title":"The radar equation — radarPower","text":"Calculates power returned echolocation pulse","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarPower.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The radar equation — radarPower","text":"","code":"radarPower(P_t, r, area, G_t = 1, G_r = 1, wl = 1)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarPower.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The radar equation — radarPower","text":"P_t Power transmitted (sender) r Range target area Effective cross-sectional area target G_t Transmitter gain G_r Receiver gain wl Wavelength (use G_r G_t)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarPower.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The radar equation — radarPower","text":"received power","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarPower.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"The radar equation — radarPower","text":"","code":"radarPower(12, 20, 0.05) #> [1] 1.889738e-09 radarPower(12, 20, 0.05, G_t=1.2, G_r=1.5, wl=0.045) #> [1] 6.888096e-12"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarRange.html","id":null,"dir":"Reference","previous_headings":"","what":"Radar range — radarRange","title":"Radar range — radarRange","text":"Calculates distance object based round trip time echolocation pulse","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarRange.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Radar range — radarRange","text":"","code":"radarRange(t, c = soundSpeed(medium = \"air\"))"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarRange.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Radar range — radarRange","text":"t Time seconds c Speed sound transmission medium m/s (default air)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarRange.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Radar range — radarRange","text":"Distance object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarRange.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Radar range — radarRange","text":"","code":"radarRange(2) #> [1] 343 radarRange(2, c=343) #> [1] 343 radarRange(2, c=soundSpeed(medium = \"sea water\")) #> [1] 1500"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radialPolygon.html","id":null,"dir":"Reference","previous_headings":"","what":"Plot a radial polygon — radialPolygon","title":"Plot a radial polygon — radialPolygon","text":"Used plot sectors, annuli horizons dielPlot() yearlyPlot(). polygon inner outer horizon - can set fixed radius vector.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radialPolygon.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plot a radial polygon — radialPolygon","text":"","code":"radialPolygon( angle1, angle2, radius1, radius2, col = \"grey\", border = NA, rot = -pi, angleinc = 0.01, reverse = TRUE, ... )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radialPolygon.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plot a radial polygon — radialPolygon","text":"angle1 Angles inner line angle2 Angles outer line radius1 Radii inner line radius2 Radii outer line col Colour polygon border Border colour (see polygon() details) rot Rotation plot, defaults pi match dielPlot() yearlyPlot() angleinc angular increment radians calculating circular lines reverse FALSE plots anti-clockwise direction ... parameters passed polygon()","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/rainfallDetection.html","id":null,"dir":"Reference","previous_headings":"","what":"Rainfall detection — rainfallDetection","title":"Rainfall detection — rainfallDetection","text":"Detects rainfall Wave. uncalibrated version Bedoya et al (2017) doi:10.1016/j.ecolind.2016.12.018 available package. hardRain package can also accessed via wrapper.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/rainfallDetection.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rainfall detection — rainfallDetection","text":"","code":"rainfallDetection(wave, method = \"bedoya2017\", ...)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/rainfallDetection.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rainfall detection — rainfallDetection","text":"wave Wave object detect rainfall method rainfall detection method use (\"bedoya2017\") ... arguments pass rain detection function","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/rainfallDetection.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rainfall detection — rainfallDetection","text":"Numeric value rainfall detection algorithm chosen.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/rainfallDetection.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Rainfall detection — rainfallDetection","text":"","code":"if (FALSE) { # \\dontrun{ rainfallDetection(sheep, method=\"bedoya2017\") } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readAudacityLabels.html","id":null,"dir":"Reference","previous_headings":"","what":"Read an Audacity label file — readAudacityLabels","title":"Read an Audacity label file — readAudacityLabels","text":"Reads Audacity label file returns either list Annotation objects data frame.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readAudacityLabels.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read an Audacity label file — readAudacityLabels","text":"","code":"readAudacityLabels(file, output = \"annotations\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readAudacityLabels.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read an Audacity label file — readAudacityLabels","text":"file Path Audacity label file. output One \"annotations\" \"data.frame\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readAudio.html","id":null,"dir":"Reference","previous_headings":"","what":"Read an audio file — readAudio","title":"Read an audio file — readAudio","text":"file used read audio file return Wave object, abstraction function various specific audio reading functions. existing method can identified attempt made use av package read audio.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readAudio.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read an audio file — readAudio","text":"","code":"readAudio(file, mime = \"auto\", from = 0, to = Inf, units = \"seconds\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readAudio.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read an audio file — readAudio","text":"file File read mime MIME type file read, \"auto\". Supported types \"audio/x-wav\" \"audio/mpeg\" (MP3) Start point file return End point file return units One \"samples\", \"seconds\", \"minutes\", \"hours\". Default \"seconds\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readAudio.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read an audio file — readAudio","text":"Wave object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readBirdNet.html","id":null,"dir":"Reference","previous_headings":"","what":"Read output files from BirdNet Analyser — readBirdNet","title":"Read output files from BirdNet Analyser — readBirdNet","text":"Reads single file, directory files, output BirdNet Analyser.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readBirdNet.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read output files from BirdNet Analyser — readBirdNet","text":"","code":"readBirdNet(file, filename_parsing = \"none\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readBirdNet.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read output files from BirdNet Analyser — readBirdNet","text":"file Filename directory filename_parsing Allows filename parsing, accepted values one none, audiomoth, timestamp.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readBirdNet.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read output files from BirdNet Analyser — readBirdNet","text":"data frame.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readRespeaker6.html","id":null,"dir":"Reference","previous_headings":"","what":"Read a file from Seeed Studio Respeaker 6 mic array — readRespeaker6","title":"Read a file from Seeed Studio Respeaker 6 mic array — readRespeaker6","text":"Seeed Studio Respeaker-6 used described documentation saves eight channel audio file channels 7 8 containing input audio. function reads file saves six channel file.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readRespeaker6.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read a file from Seeed Studio Respeaker 6 mic array — readRespeaker6","text":"","code":"readRespeaker6(filename, from = 1, to = Inf, units = \"samples\", header = FALSE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readRespeaker6.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read a file from Seeed Studio Respeaker 6 mic array — readRespeaker6","text":"filename file read. start reading wave units. stop reading wave units. units Units given, default \"samples\", can set time intervals \"seconds\". header TRUE, just header information Wave file returned, otherwise (default) whole Wave object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readRespeaker6.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read a file from Seeed Studio Respeaker 6 mic array — readRespeaker6","text":"WaveMC object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/referenceIntensity.html","id":null,"dir":"Reference","previous_headings":"","what":"Reference intensity — referenceIntensity","title":"Reference intensity — referenceIntensity","text":"Provides standard reference intensity level.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/referenceIntensity.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reference intensity — referenceIntensity","text":"","code":"referenceIntensity(unit = \"watt_cm2\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/referenceIntensity.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reference intensity — referenceIntensity","text":"unit Unit return, \"watt_cm2\"","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/referenceIntensity.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Reference intensity — referenceIntensity","text":"","code":"ri <- referenceIntensity()"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/referencePressure.html","id":null,"dir":"Reference","previous_headings":"","what":"Reference pressure — referencePressure","title":"Reference pressure — referencePressure","text":"Provides standard reference pressure level.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/referencePressure.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reference pressure — referencePressure","text":"","code":"referencePressure(unit = \"Pa\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/referencePressure.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reference pressure — referencePressure","text":"unit Unit return, \"Pa\" \"dyne_cm2\"","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/referencePressure.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Reference pressure — referencePressure","text":"","code":"rp <- referencePressure() rp <- referencePressure(unit=\"dyne_cm2\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/region.html","id":null,"dir":"Reference","previous_headings":"","what":"Specify a region with a file to analyse — region","title":"Specify a region with a file to analyse — region","text":"Specifies time-bounded region analyse.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/region.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Specify a region with a file to analyse — region","text":"","code":"region(unit, from = 0, to = Inf)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/region.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Specify a region with a file to analyse — region","text":"unit Unit time (one samples, seconds, minutes, hours) Start time End time","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/region.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Specify a region with a file to analyse — region","text":"TimeRegion object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/resonantFrequency.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate the resonant frequency — resonantFrequency","title":"Calculate the resonant frequency — resonantFrequency","text":"Calculates resonant frequency given inductance capacitance. acoustic case inductance inertia mass, capacitance elasticity (bulk modulus) resistance composed air resistance related quantities. units SI.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/resonantFrequency.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate the resonant frequency — resonantFrequency","text":"","code":"resonantFrequency(L, C = \"default\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/resonantFrequency.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate the resonant frequency — resonantFrequency","text":"L Inductance C Capacitance, default IUPAC standard pressure.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/resonantFrequency.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Calculate the resonant frequency — resonantFrequency","text":"isothermal compression, bulk modulus equal pressure. default value C therefore IUPAC standard pressure.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/resonantFrequency.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Calculate the resonant frequency — resonantFrequency","text":"","code":"f <- resonantFrequency(L=1)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sDuration.html","id":null,"dir":"Reference","previous_headings":"","what":"Sample duration — sDuration","title":"Sample duration — sDuration","text":"Calculates time represented n samples Wave.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sDuration.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sample duration — sDuration","text":"","code":"sDuration(n = 1, wave = NULL, samp.rate = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sDuration.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sample duration — sDuration","text":"n number samples wave Wave object containing pulses samp.rate Integer sampling rate","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sDuration.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sample duration — sDuration","text":"numeric value seconds","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sDuration.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Sample duration — sDuration","text":"","code":"sDuration(n=20, samp.rate=44100) #> [1] 0.0004535147 if (FALSE) { # \\dontrun{ sDuration(n=20, wave=sheep)#' } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sheepFrequencyStats.html","id":null,"dir":"Reference","previous_headings":"","what":"Sheep frequencyStats — sheepFrequencyStats","title":"Sheep frequencyStats — sheepFrequencyStats","text":"frequencyStats sheep data file seewave package.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sheepFrequencyStats.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sheep frequencyStats — sheepFrequencyStats","text":"","code":"sheepFrequencyStats"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sheepFrequencyStats.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Sheep frequencyStats — sheepFrequencyStats","text":"object class list length 3.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/shimmer.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate the shimmer in a Wave object — shimmer","title":"Calculate the shimmer in a Wave object — shimmer","text":"Jitter measure variability amplitudes within periods waveform. Relative shimmer scaled shimmer analysed waveform.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/shimmer.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate the shimmer in a Wave object — shimmer","text":"","code":"shimmer(wave)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/shimmer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate the shimmer in a Wave object — shimmer","text":"wave Wave object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/shimmer.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Calculate the shimmer in a Wave object — shimmer","text":"vector zero crossing locations","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/shimmer.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Calculate the shimmer in a Wave object — shimmer","text":"","code":"if (FALSE) { # \\dontrun{ shimmer(sheep) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/slash-PseudoWave-numeric-method.html","id":null,"dir":"Reference","previous_headings":"","what":"PseudoWave scalar division — /,PseudoWave,numeric-method","title":"PseudoWave scalar division — /,PseudoWave,numeric-method","text":"PseudoWave scalar division","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/slash-PseudoWave-numeric-method.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"PseudoWave scalar division — /,PseudoWave,numeric-method","text":"","code":"# S4 method for class 'PseudoWave,numeric' e1/e2"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/slash-PseudoWave-numeric-method.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"PseudoWave scalar division — /,PseudoWave,numeric-method","text":"e1 Input 1 e2 Input 2","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sort_annotations.html","id":null,"dir":"Reference","previous_headings":"","what":"Sort annotations — sort_annotations","title":"Sort annotations — sort_annotations","text":"Sorts list annotations either start time, frequency, .","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sort_annotations.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sort annotations — sort_annotations","text":"","code":"sort_annotations(annotations, domain = \"time\", decreasing = FALSE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sort_annotations.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sort annotations — sort_annotations","text":"annotations list Annotation objects. domain Domain annotations, either \"time\", \"frequency\", \"\". decreasing TRUE, sort decreasing order.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sort_annotations.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sort annotations — sort_annotations","text":"list Annotation objects.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/soundSpeed.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate the speed of sound in a medium — soundSpeed","title":"Calculate the speed of sound in a medium — soundSpeed","text":"Given sufficient parameters (.e. wavelength frequency, bulk modulus density) function calculates speed sound.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/soundSpeed.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate the speed of sound in a medium — soundSpeed","text":"","code":"soundSpeed( medium = NULL, method = NULL, wl = NULL, f = NULL, bulkModulus = NULL, density = NULL, ... )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/soundSpeed.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate the speed of sound in a medium — soundSpeed","text":"medium Propagation medium (e.g. \"air\"), \"\" return list available media. method Use specific method calculate speed sound (see Details). wl Wavelength f Frequency bulkModulus Bulk modulus density Density ... Additional parameters passed method.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/soundSpeed.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Calculate the speed of sound in a medium — soundSpeed","text":"speed sound can calculated using following methods: cramer Uses method described cramer1993;textualsonicscrewdriver. Additional parameters : temp Temperature temp.unit Temperature unit pressure Pressure pressure.unit Pressure unit RH Relative humidity MoleFracCO2 Mole fraction CO2 seewave Delegates calculation speed sound air package seewave seewave2008sonicscrewdriver. calculation . performed \\(\\text{speed} = 331.4 + 0.6 \\times \\text{temp}\\). Additional parameters : temp Temperature","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/soundSpeed.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Calculate the speed of sound in a medium — soundSpeed","text":"","code":"soundSpeed(medium=\"air\") #> [1] 343 soundSpeed(medium=\"sea water\") #> [1] 1500 soundSpeed(method=\"cramer\", temp=14, pressure=3, RH=10) #> [1] 342.682 soundSpeed(method=\"cramer\", temp=14, temp.unit=\"C\", pressure=3, pressure.unit=\"kPa\", RH=10) #> [1] 342.682 t <- 1:30 s <- lapply(t, \\(x){soundSpeed(method=\"cramer\", temp=x)})"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/specStats.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate and plot statistics on a frequency spectrum — specStats","title":"Calculate and plot statistics on a frequency spectrum — specStats","text":"Given list outputs meanspec generates plot mean shown line, either minimum/maximum values one standard deviation shown ribbon.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/specStats.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate and plot statistics on a frequency spectrum — specStats","text":"","code":"specStats(spectra, stats = \"minMax\", line.col = \"black\", ribbon.col = \"grey70\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/specStats.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate and plot statistics on a frequency spectrum — specStats","text":"spectra list spectra stats Either minMax sd line.col Colour line ribbon.col Colour ribbon","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/specStats.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Calculate and plot statistics on a frequency spectrum — specStats","text":"ggplot2 object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/spectrogram_maad-class.html","id":null,"dir":"Reference","previous_headings":"","what":"An S4 class to represent a spectrogram from scikit-maad. — spectrogram_maad-class","title":"An S4 class to represent a spectrogram from scikit-maad. — spectrogram_maad-class","text":"S4 class represent spectrogram scikit-maad.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/spectrogram_maad-class.html","id":"slots","dir":"Reference","previous_headings":"","what":"Slots","title":"An S4 class to represent a spectrogram from scikit-maad. — spectrogram_maad-class","text":"Sxx spectrogram matrix tn time vector fn frequency vector extents extents spectrogram. list tmin, tmax, fmin, fmax.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ste.html","id":null,"dir":"Reference","previous_headings":"","what":"Short term energy — ste","title":"Short term energy — ste","text":"Computes short term energy Wave.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ste.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Short term energy — ste","text":"","code":"ste(wave, method = \"dietrich2004\", ...)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ste.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Short term energy — ste","text":"wave Wave object method method used calculate short term energy, default \"dietrich2004\" use dietrich2004sonicscrewdriver. ... arguments pass ste method.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ste.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Short term energy — ste","text":"vector short term energy values","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ste.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Short term energy — ste","text":"","code":"if (FALSE) { # \\dontrun{ ste(sheep, method=\"dietrich2004\") } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sub-Wave-TimeRegion-method.html","id":null,"dir":"Reference","previous_headings":"","what":"Allow subsetting a Wave object with a TimeRegion — [,Wave,TimeRegion-method","title":"Allow subsetting a Wave object with a TimeRegion — [,Wave,TimeRegion-method","text":"Allow subsetting Wave object TimeRegion","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sub-Wave-TimeRegion-method.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Allow subsetting a Wave object with a TimeRegion — [,Wave,TimeRegion-method","text":"","code":"# S4 method for class 'Wave,TimeRegion' x[i]"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sub-Wave-TimeRegion-method.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Allow subsetting a Wave object with a TimeRegion — [,Wave,TimeRegion-method","text":"x Wave Object TimeRegion object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/subtractSpectra.html","id":null,"dir":"Reference","previous_headings":"","what":"Subtract two spectra from seewave — subtractSpectra","title":"Subtract two spectra from seewave — subtractSpectra","text":"function takes two spectra seewave (equivalent) subtracts values. spectra must bins.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/subtractSpectra.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Subtract two spectra from seewave — subtractSpectra","text":"","code":"subtractSpectra(s1, s2, coerceNegative = TRUE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/subtractSpectra.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Subtract two spectra from seewave — subtractSpectra","text":"s1 First spectrum s2 Second spectrum coerceNegative Sets values zero zero output.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/subtractSpectra.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Subtract two spectra from seewave — subtractSpectra","text":"spectrum s1 - s2","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/subtractSpectra.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Subtract two spectra from seewave — subtractSpectra","text":"","code":"if (FALSE) { # \\dontrun{ subtractSpectra(spec1, spec2) subtractSpectra(spec1, spec2, coerceNegative=TRUE) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sweptsine.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a sine sweep — sweptsine","title":"Generate a sine sweep — sweptsine","text":"Generates frequency swept sine wave (either linear logarithmic) returns Wave object vector.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sweptsine.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a sine sweep — sweptsine","text":"","code":"sweptsine( f0 = 100, f1 = 2500, mode = \"linear\", sweep.time = 1, time.unit = \"seconds\", samp.rate = 44100, output = \"wave\", ... )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sweptsine.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a sine sweep — sweptsine","text":"f0 Start frequency f1 End frequency mode One \"linear\", \"log\" sweep.time Duration swept wave time.unit One \"seconds\", \"samples\" samp.rate Sample rate swept wave output \"wave\" Wave object, \"vector\" ... Additional arguments pass data2Wave","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sweptsine.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a sine sweep — sweptsine","text":"swept wave object type specified output.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sweptsine.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a sine sweep — sweptsine","text":"","code":"#Generate a swept sine wave between 0Hz and 10kHz. w <- sweptsine(0, 10e3) #Generate a swept sine wave between 0Hz and 10kHz and normalise it. w <- normalise(sweptsine(0, 10e3)) #Generate a stereo swept sine wave between 100Hz and 1KHz. w <- tuneR::stereo(sweptsine(100, 1e3)) #Generate an exponentially swept sine wave between 100Hz and 1KHz. w <- sweptsine(100, 1e3, mode=\"log\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tSamples.html","id":null,"dir":"Reference","previous_headings":"","what":"Samples per time period — tSamples","title":"Samples per time period — tSamples","text":"Calculates number samples given duration wave","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tSamples.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Samples per time period — tSamples","text":"","code":"tSamples(time = 1, wave = NULL, samp.rate = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tSamples.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Samples per time period — tSamples","text":"time duration seconds wave Wave object containing pulses samp.rate Integer sampling rate","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tSamples.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Samples per time period — tSamples","text":"Number samples","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tSamples.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Samples per time period — tSamples","text":"","code":"tSamples(10, samp.rate=44100) #> [1] 441000 if (FALSE) { # \\dontrun{ tSamples(10, wave=sheep) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tagWave.html","id":null,"dir":"Reference","previous_headings":"","what":"Tag a Wave or WaveMC object — tagWave","title":"Tag a Wave or WaveMC object — tagWave","text":"function takes Wave/WaveMC object (list objects) returns corresponding tagged version (TaggedWave TaggedWaveMC).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tagWave.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tag a Wave or WaveMC object — tagWave","text":"","code":"tagWave(w, origin = \"user\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tagWave.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tag a Wave or WaveMC object — tagWave","text":"w Wave WaveMC object (list objects). origin origin object (default \"user\").","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tagWave.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tag a Wave or WaveMC object — tagWave","text":"TaggedWave TaggedWaveMC object (list objects).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/times-PseudoWave-numeric-method.html","id":null,"dir":"Reference","previous_headings":"","what":"PseudoWave scalar manipulation — *,PseudoWave,numeric-method","title":"PseudoWave scalar manipulation — *,PseudoWave,numeric-method","text":"PseudoWave scalar manipulation","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/times-PseudoWave-numeric-method.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"PseudoWave scalar manipulation — *,PseudoWave,numeric-method","text":"","code":"# S4 method for class 'PseudoWave,numeric' e1 * e2"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/times-PseudoWave-numeric-method.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"PseudoWave scalar manipulation — *,PseudoWave,numeric-method","text":"e1 Input 1 e2 Input 2","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/times-numeric-PseudoWave-method.html","id":null,"dir":"Reference","previous_headings":"","what":"Numeric multiplication by PseudoWave — *,numeric,PseudoWave-method","title":"Numeric multiplication by PseudoWave — *,numeric,PseudoWave-method","text":"Numeric multiplication PseudoWave","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/times-numeric-PseudoWave-method.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Numeric multiplication by PseudoWave — *,numeric,PseudoWave-method","text":"","code":"# S4 method for class 'numeric,PseudoWave' e1 * e2"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/times-numeric-PseudoWave-method.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Numeric multiplication by PseudoWave — *,numeric,PseudoWave-method","text":"e1 Input 1 e2 Input 2","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/typicalVolume.html","id":null,"dir":"Reference","previous_headings":"","what":"Typical volumes — typicalVolume","title":"Typical volumes — typicalVolume","text":"Typical volumes everyday things.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/typicalVolume.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Typical volumes — typicalVolume","text":"","code":"typicalVolume(thing = NA_character_)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/typicalVolume.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Typical volumes — typicalVolume","text":"thing Volume thing, missing returns volumes","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/typicalVolume.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Typical volumes — typicalVolume","text":"Typical volume thing dBA, thing parameter data frame volumes","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/typicalVolume.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Typical volumes — typicalVolume","text":"","code":"typicalVolume() #> thing dBA #> 1 steam engine 85 #> 2 printing works 87 #> 3 diesel electric generator 96 #> 4 screw-heading machine 101 #> 5 weaving shed 104 #> 6 sawmill chipper 105 #> 7 metalwork grinder 106 #> 8 wood-planing machine 108 #> 9 metal saw 110 #> 10 rock band 115 #> 11 boiler works 118 #> 12 metal hammering 118 #> 13 jet take-off 120 #> 14 rocket launch 160 typicalVolume(\"rocket launch\") #> [1] 160"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tzRot.html","id":null,"dir":"Reference","previous_headings":"","what":"Converts a timezone offset into a rotation — tzRot","title":"Converts a timezone offset into a rotation — tzRot","text":"Given timezone offset hours returns rotation radians apply values diel plot.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tzRot.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Converts a timezone offset into a rotation — tzRot","text":"","code":"tzRot(tz, init = pi)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tzRot.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Converts a timezone offset into a rotation — tzRot","text":"tz Timezone numeric init Initial rotation. Defaults pi.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/untagWave.html","id":null,"dir":"Reference","previous_headings":"","what":"Untag a TaggedWave or TaggedWaveMC object — untagWave","title":"Untag a TaggedWave or TaggedWaveMC object — untagWave","text":"function takes TaggedWave/TaggedWaveMC object (list objects) returns corresponding Wave/WaveMC object (list objects).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/untagWave.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Untag a TaggedWave or TaggedWaveMC object — untagWave","text":"","code":"untagWave(w)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/untagWave.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Untag a TaggedWave or TaggedWaveMC object — untagWave","text":"w TaggedWave TaggedWaveMC object (list objects).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/untagWave.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Untag a TaggedWave or TaggedWaveMC object — untagWave","text":"Wave WaveMC object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/untagWave.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Untag a TaggedWave or TaggedWaveMC object — untagWave","text":"","code":"if (FALSE) { # \\dontrun{ w <- noise(\"white\") tw <- tagWave(w) w2 <- untagWave(tw) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/upsample.html","id":null,"dir":"Reference","previous_headings":"","what":"Upsample a wave — upsample","title":"Upsample a wave — upsample","text":"Used upsample Wave object. upsampled sample rate must natural multiple current sample rate.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/upsample.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Upsample a wave — upsample","text":"","code":"upsample(wave, upsample.rate, method = \"basic\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/upsample.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Upsample a wave — upsample","text":"wave Wave object upsample. upsample.rate sample rate upsample . method \"basic\" linear, function interpolate NAs vector","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/upsample.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Upsample a wave — upsample","text":"resampled Wave object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/upsample.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Upsample a wave — upsample","text":"","code":"wave <- tuneR::sine(4000, samp.rate=44100) wave2 <- upsample(wave, 88200)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/validateIsWave.html","id":null,"dir":"Reference","previous_headings":"","what":"Check an object is a Wave object — validateIsWave","title":"Check an object is a Wave object — validateIsWave","text":"Helper function test input Wave object. create error .","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/validateIsWave.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check an object is a Wave object — validateIsWave","text":"","code":"validateIsWave(wave)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/validateIsWave.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check an object is a Wave object — validateIsWave","text":"wave Object test","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/windowing.html","id":null,"dir":"Reference","previous_headings":"","what":"Windowing Function for Wave Objects — windowing","title":"Windowing Function for Wave Objects — windowing","text":"Separates Wave object windows defined length runs function window section. Windows may overlap, function can make use 'parallel' package multi-core processing. also show progress bar 'pbapply' package installed.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/windowing.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Windowing Function for Wave Objects — windowing","text":"","code":"windowing( wave, window.length = 1000, FUN, window.overlap = 0, bind.wave = FALSE, complete.windows = TRUE, cluster = NULL, ... )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/windowing.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Windowing Function for Wave Objects — windowing","text":"wave Wave object filename. Using filenames may save loading entire large file memory. window.length length analysis window (samples). FUN FUN applied windows. window.overlap overlap successive windows (samples), negative value result gap windows. bind.wave TRUE FUN returns wave objects, combined single object complete.windows TRUE (default) final window processed unless length equal window.length. cluster cluster form 'parallel' package multi-core computation. ... Additional parameters FUN","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/windowing.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Windowing Function for Wave Objects — windowing","text":"","code":"if (FALSE) { # \\dontrun{ windowing(wave, window.length=1000, FUN=duration, window.overlap=0, bind.wave=TRUE) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/writeAnnotationWave.html","id":null,"dir":"Reference","previous_headings":"","what":"Save a time region defined by an Annotation object as a Wave file — writeAnnotationWave","title":"Save a time region defined by an Annotation object as a Wave file — writeAnnotationWave","text":"Save time region defined Annotation object Wave file","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/writeAnnotationWave.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Save a time region defined by an Annotation object as a Wave file — writeAnnotationWave","text":"","code":"writeAnnotationWave(annotation, wave = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/writeAnnotationWave.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Save a time region defined by an Annotation object as a Wave file — writeAnnotationWave","text":"annotation Annotation object. wave (Optional) Wave object, given load wave file Annotation filename.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/writeAudacityLabels.html","id":null,"dir":"Reference","previous_headings":"","what":"Write an Audacity label file — writeAudacityLabels","title":"Write an Audacity label file — writeAudacityLabels","text":"Writes list Annotation objects Audacity label file. Internally uses write.audacity() function seewave package seewave2008sonicscrewdriver.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/writeAudacityLabels.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Write an Audacity label file — writeAudacityLabels","text":"","code":"writeAudacityLabels(annotations, file)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/writeAudacityLabels.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Write an Audacity label file — writeAudacityLabels","text":"annotations list Annotation objects. file Path Audacity label file.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyFraction.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate the fraction of a year given by a value — yearlyFraction","title":"Calculate the fraction of a year given by a value — yearlyFraction","text":"Given object can coerced POSIXlt, return fraction year represented object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyFraction.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate the fraction of a year given by a value — yearlyFraction","text":"","code":"yearlyFraction(t, year = 2022, input = \"POSIX\", unit = \"radians\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyFraction.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate the fraction of a year given by a value — yearlyFraction","text":"t Object converted fraction year Year calculate fractions (allows leap years) input One POSIXlt (default) unit set radians outputs position around circle. set fraction outputs raw fraction.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyLabels.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate labels for a yearly plot — yearlyLabels","title":"Generate labels for a yearly plot — yearlyLabels","text":"Generates monthly labels yearlyPlot()..","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyLabels.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate labels for a yearly plot — yearlyLabels","text":"","code":"yearlyLabels()"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyPlot.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a yearly plot — yearlyPlot","title":"Create a yearly plot — yearlyPlot","text":"ToDO......","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyPlot.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a yearly plot — yearlyPlot","text":"","code":"yearlyPlot( year = 2022, lat, lon, limits = c(0, 2), plot = NULL, method = \"plotrix\", legend = F )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyPlot.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a yearly plot — yearlyPlot","text":"year Year plot (allows leap years). lat Numeric latitude. lon Numeric longitude. limits Plotting limits daylight regions, default c(1,2) plot Character vector components plot method Plotting library use legend Whether show legend","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyPositions.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate positions of labels for a yearly plot — yearlyPositions","title":"Generate positions of labels for a yearly plot — yearlyPositions","text":"Generates positions monthly labels dielPlot() radians. positions can either start month, middle month.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyPositions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate positions of labels for a yearly plot — yearlyPositions","text":"","code":"yearlyPositions(year = 2022, format = \"months\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyPositions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate positions of labels for a yearly plot — yearlyPositions","text":"year Year calculate format One months, mid-months, days","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyPositions.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Generate positions of labels for a yearly plot — yearlyPositions","text":"function allows leap years year parameter provided.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zeroSpectrum.html","id":null,"dir":"Reference","previous_headings":"","what":"Zero spectrum — zeroSpectrum","title":"Zero spectrum — zeroSpectrum","text":"function takes spectrum seewave creates new zero-valued spectrum structure.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zeroSpectrum.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Zero spectrum — zeroSpectrum","text":"","code":"zeroSpectrum(s1)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zeroSpectrum.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Zero spectrum — zeroSpectrum","text":"s1 Spectrum emulate structure .","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zeroSpectrum.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Zero spectrum — zeroSpectrum","text":"zero-valued spectrum.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zeroSpectrum.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Zero spectrum — zeroSpectrum","text":"","code":"if (FALSE) { # \\dontrun{ zeroSpectrum(spec) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zerocross.html","id":null,"dir":"Reference","previous_headings":"","what":"Identify zero crossings in a Wave object — zerocross","title":"Identify zero crossings in a Wave object — zerocross","text":"Returns vector position (samples) zero crossings Wave object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zerocross.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Identify zero crossings in a Wave object — zerocross","text":"","code":"zerocross(wave)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zerocross.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Identify zero crossings in a Wave object — zerocross","text":"wave Wave object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zerocross.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Identify zero crossings in a Wave object — zerocross","text":"vector zero crossing locations","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zerocross.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Identify zero crossings in a Wave object — zerocross","text":"","code":"if (FALSE) { # \\dontrun{ zerocross(sheep) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"sonicscrewdriver-007","dir":"Changelog","previous_headings":"","what":"sonicscrewdriver 0.0.7","title":"sonicscrewdriver 0.0.7","text":"CRAN release: 2024-05-11","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"new-functionality-0-0-7","dir":"Changelog","previous_headings":"","what":"New functionality","title":"sonicscrewdriver 0.0.7","text":"sweptsine() can generate logarithmic sweeps mode=“log” normalise() wrapper tuneR::normalize() detect bit depth data2Wave() uses new normalise() wrapper","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"documentation-0-0-7","dir":"Changelog","previous_headings":"","what":"Documentation","title":"sonicscrewdriver 0.0.7","text":"additional examples sweptsine()","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"fixes-0-0-7","dir":"Changelog","previous_headings":"","what":"Fixes","title":"sonicscrewdriver 0.0.7","text":"internal function normalise spectrum better testing bind.wave parameter windowing().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"sonicscrewdriver-006","dir":"Changelog","previous_headings":"","what":"sonicscrewdriver 0.0.6","title":"sonicscrewdriver 0.0.6","text":"CRAN release: 2024-03-01","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"fixes-0-0-6","dir":"Changelog","previous_headings":"","what":"Fixes","title":"sonicscrewdriver 0.0.6","text":"issued identified Win build convert2seconds() numeric value < 1000 passed HHMM.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"sonicscrewdriver-005","dir":"Changelog","previous_headings":"","what":"sonicscrewdriver 0.0.5","title":"sonicscrewdriver 0.0.5","text":"CRAN release: 2024-02-23","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"new-functionality-0-0-5","dir":"Changelog","previous_headings":"","what":"New functionality","title":"sonicscrewdriver 0.0.5","text":"use BirdNET-Analyzer within R using reticulate readAudio() generic function read audio files readAudacityLabels() read Audacity label files citation() information angle conversion Dolbear’s law audioblast() - search recordings analyses audioblast.org audioblastDownload() - Download files audioBlast allChannels analysing multi-channel audio read Respeaker6 formatted files","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"new-classes-0-0-5","dir":"Changelog","previous_headings":"","what":"New classes","title":"sonicscrewdriver 0.0.5","text":"Annotation class (recording manipulating annotations) PseudoWave class (e.g. apply noise file length) TaggedWaves class (document metadata processing) WaveFilter class (supports applying filters using pipes)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"fixes-0-0-5","dir":"Changelog","previous_headings":"","what":"Fixes","title":"sonicscrewdriver 0.0.5","text":"audiomothWave() fix (comments consistently placed header)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"sonicscrewdriver-004","dir":"Changelog","previous_headings":"","what":"sonicscrewdriver 0.0.4","title":"sonicscrewdriver 0.0.4","text":"CRAN release: 2021-05-02 support reading AudioMoth configuration files support reading AudioMoth metadata wave files audioRead function convert audio file types Wave object parseFilename now accepts POSIX timestamp format provides typical volumes (decibels)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"sonicscrewdriver-003","dir":"Changelog","previous_headings":"","what":"sonicscrewdriver 0.0.3","title":"sonicscrewdriver 0.0.3","text":"CRAN release: 2020-11-15 Jitter shimmer functions added.","code":""}] +[{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/CODE-OF-CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"interest fostering open welcoming environment, contributors maintainers pledge making participation project community harassment-free experience everyone, regardless age, body size, disability, ethnicity, gender identity expression, level experience, nationality, personal appearance, race, religion, sexual identity orientation.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/CODE-OF-CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes creating positive environment include: Using welcoming inclusive language respectful differing viewpoints experiences Gracefully accepting constructive criticism Focusing best community Showing empathy towards community members Examples unacceptable behavior participants include: use sexualized language imagery unwelcome sexual attention advances Trolling, insulting/derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical electronic address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/CODE-OF-CONDUCT.html","id":"our-responsibilities","dir":"","previous_headings":"","what":"Our Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Project maintainers responsible clarifying standards acceptable behavior expected take appropriate fair corrective action response instances unacceptable behavior. Project maintainers right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, ban temporarily permanently contributor behaviors deem inappropriate, threatening, offensive, harmful.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/CODE-OF-CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within project spaces public spaces individual representing project community. Examples representing project community include using official project e-mail address, posting via official social media account, acting appointed representative online offline event. Representation project may defined clarified project maintainers.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/CODE-OF-CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported contacting project team edwbaker@gmail.com. project team review investigate complaints, respond way deems appropriate circumstances. project team obligated maintain confidentiality regard reporter incident. details specific enforcement policies may posted separately. Project maintainers follow enforce Code Conduct good faith may face temporary permanent repercussions determined members project’s leadership.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/CODE-OF-CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 1.4, available http://contributor-covenant.org/version/1/4","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/audioblast.html","id":"what-is-audioblast","dir":"Articles","previous_headings":"","what":"What is audioblast?","title":"Using audioBlast with R","text":"Audioblast discovery tool bioacoustic ecoacoustic recordings. can use search recordings (e.g. species, location, date), annotations recordings, analysis results traits. Audioblast currently hosted Natural History Museum London. conceived Ed Baker University York part Leverhulme Trust funded Automated Acoustic Observatories project.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/audioblast.html","id":"accessing-audioblast","dir":"Articles","previous_headings":"","what":"Accessing audioblast","title":"Using audioBlast with R","text":"audioblast() function SonicScrewdriveR wrapper allowing full access Audioblast API. also possible download many recordings audioblast using audioblastDownload().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/augment-audio-data.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Augmenting audio data in R with SonicScrewdriveR","text":"Augmenting data common practice machine learning. process creating new data existing data (e.g. adding noise). done increase size training data make model robust. article show augment audio data R using sonicscrewdriver package. generateX() functions sonicscrewdriver designed operate Wave-like objects (Wave WaveMC tuneR Tagged equivalents) list Wave-like objects. Similarly, functions return list Wave-like objects. means can chain functions together create complex data augmentation pipelines.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/augment-audio-data.html","id":"types-of-augmentation","dir":"Articles","previous_headings":"","what":"Types of augmentation","title":"Augmenting audio data in R with SonicScrewdriveR","text":"order demonstrate data augmentation process, use sonicscrewdriver package generate Dirac pulse.","code":"# Generate a Dirac pulse p <- pulse(\"dirac\") # Plot the pulse seewave::oscillo(p)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/augment-audio-data.html","id":"noise-augmentation","dir":"Articles","previous_headings":"Types of augmentation","what":"Noise augmentation","title":"Augmenting audio data in R with SonicScrewdriveR","text":"Noise augmentation common technique used increase size training data. process adding noise original data. sonicscrewdriver package provides generateNoise() function add noise audio data. example add two different amounts white noise Dirac pulse.","code":"augmented <- c( generateNoise(p, \"white\", noise.ratio=0.1), generateNoise(p, \"white\", noise.ratio=0.3) ) for (i in 1:length(augmented)) { seewave::oscillo(augmented[[i]]) }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/augment-audio-data.html","id":"time-shifting-rotationpadding","dir":"Articles","previous_headings":"Types of augmentation","what":"Time shifting (rotation/padding)","title":"Augmenting audio data in R with SonicScrewdriveR","text":"Time shifting process shifting audio data certain number samples. sonicscrewdriver package provides generateTimeShift() function rotate audio data, either rotating audio data within file, padding file silence. demonstrate time shifting generate sum sine wave Dirac pulse. Time shifting inserting silence. Alternatively, can rotate audio data.","code":"p1 <- tuneR::sine(440, duration=44100*3) p2 <- pulse(\"dirac\", duration=44100*3) p <- 0.25*p1 + normalise(p2) seewave::oscillo(p) # Rotate the audio data by one second rotated <- generateTimeShift(p, amount=1) seewave::oscillo(rotated[[1]]) # Rotate the audio data by one second rotated <- generateTimeShift(p, type=\"rotate\", amount=1) seewave::oscillo(rotated[[1]])"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/augment-audio-data.html","id":"time-masking","dir":"Articles","previous_headings":"","what":"Time-masking","title":"Augmenting audio data in R with SonicScrewdriveR","text":"Time-masking process zeroing section audio data. sonicscrewdriver package provides generateTimeMask() function mask section audio data. demonstrate time masking first generate sine wave. Random masking sets random section audio data zero. example use duty cycle 0.95, means 5% audio data set zero. also possible introduce masking using square wave. n.periods parameter controls number periods square wave, dutyCycle parameter controls duty cycle square wave.","code":"# Generate a sine wave w <- tuneR::sine(1000, duration=100) # Plot the left audio channel plot(w@left) # Mask the audio data masked <- generateTimeMask(w, method=\"random\", dutyCycle=0.95) plot(masked@left) # Mask the audio data masked <- generateTimeMask(w, method=\"squarewave\", dutyCycle=0.5, n.periods=5) plot(masked@left)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/augment-audio-data.html","id":"combining-augmentations","dir":"Articles","previous_headings":"","what":"Combining augmentations","title":"Augmenting audio data in R with SonicScrewdriveR","text":"sonicscrewdriver package allows chain together multiple augmentations create complex data augmentation pipelines. example, can add noise audio data rotate audio data. possible use anonymous functions add multiple augmentations single step. can effectively used generate large amounts augmented data. code generates three different noise augmented versions input, two different time-shifted versions , yielding six augmented versions. approach can used list initial Wave-like objects.","code":"# Load some test audio data f <- system.file(\"extdata\", \"AUDIOMOTH.flac\", package=\"sonicscrewdriver\") w <- readAudio(f) # Add noise to the audio data and then rotate the audio data using pipes augmented <- w |> generateNoise(\"white\", noise.ratio=0.1) |> generateTimeShift(amount=1) # Create list of data and augmentations data <- c(w, augmented) # Load some test audio data f <- system.file(\"extdata\", \"AUDIOMOTH.flac\", package=\"sonicscrewdriver\") w <- readAudio(f) # Add noise to the audio data and then rotate the audio data using pipes augmented <- w |> {\\(x) c(generateNoise(x, \"white\", noise.ratio=0.1), generateNoise(x, \"white\", noise.ratio=0.3), generateNoise(x, \"white\", noise.ratio=0.5)) }() |> {\\(x) c(generateTimeShift(x, amount=1), generateTimeShift(x, amount=2)) }() # Create list of data and augmentations data <- c(w, augmented) # Load some test audio data f <- system.file(\"extdata\", \"AUDIOMOTH.flac\", package=\"sonicscrewdriver\") w <- list( readAudio(f), readAudio(f), readAudio(f) ) # Add noise to the audio data and then rotate the audio data using pipes and anonymous functions augmented <- w |> {\\(x) c(generateNoise(x, \"white\", noise.ratio=0.1), generateNoise(x, \"white\", noise.ratio=0.3), generateNoise(x, \"white\", noise.ratio=0.5)) }() |> {\\(x) c(generateTimeShift(x, amount=1), generateTimeShift(x, amount=2)) }() # Create list of data and augmentations data <- c(w, augmented)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/converting-code.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Converting code to work with SonicScrewdriveR","text":"SonicScrewdriveR introduces several tools working audio data, TaggedWave TaggedWaveMC formats. Inside SonicScrewdriveR Tagged non-Tagged versions Wave-like objects can used interchangeably, however necessarily true functions packages. guide aimed end users package developers want convert code work SonicScrewdriveR.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/converting-code.html","id":"taggedwave-and-taggedwavemc","dir":"Articles","previous_headings":"Introduction","what":"TaggedWave and TaggedWaveMC","title":"Converting code to work with SonicScrewdriveR","text":"try use function expects Wave object TaggedWave object, get error. end user can use untagWave function convert TaggedWave object Wave object. untagWave function can also used ‘untag’ TaggedWaveMC object. fix function package can make use inherits() rather alternative methods. TaggedWave inherits Wave can treated like Wave code. technique can used TaggedWaveMC objects inherits(w, \"WaveMC\").","code":"# Generate a `Wave` and `TaggedWave` sine w <- tuneR::sine(440) tw <- tagWave(w) # This will fail seewave::oscillo(tw) #> Error in seewave::oscillo(tw): argument \"f\" is missing, with no default # This will work seewave::oscillo(untagWave(tw)) # Methods that fail is(w, \"Wave\") class(w) == \"Wave\" # Method that works inherits(w, \"Wave\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/converting-code.html","id":"adding-a-process-to-a-tagged-wave-like-object","dir":"Articles","previous_headings":"Introduction > TaggedWave and TaggedWaveMC","what":"Adding a process to a Tagged Wave-like object","title":"Converting code to work with SonicScrewdriveR","text":"want add process TaggedWave object can use addProcess method. can either called end user, functions aware Tagged versions.","code":"# End user using non-Tagged aware function seewave::oscillo(untag(tw)) addProcess(tw, \"seewave::oscillo\") # Inside a Tagged aware function addProcess( tw, process = \"mypkg::functionToCountChannels\", output = list(channels = 2) )"},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/manage_audio.html","id":"reading-audio-files","dir":"Articles","previous_headings":"Managing audio in R with SonicScrewdriveR","what":"Reading audio files","title":"Managing audio in R","text":"Several functions available read audio files R, including readWave() readMP3() functions tuneR package, well tools package av. SonicScrewdriveR simplifies reading audio files providing single wrapper functions, readAudio(), can read audio files variety formats, including WAV, MP3, FLAC.","code":"filename <- system.file(\"extdata\", \"AUDIOMOTH.WAV\", package=\"sonicscrewdriver\") w <- readAudio(filename)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/manage_audio.html","id":"performing-analyses-on-channels","dir":"Articles","previous_headings":"Managing audio in R with SonicScrewdriveR","what":"Performing analyses on channels","title":"Managing audio in R","text":"existing functions operate single channel time. may cause unnecessarily complex workflows bulk analysing files different numbers channels. allChannels() function applies function channel returns list analyses. technique allows analysis performed channel, without reference number channels audio file. Optionally, cluster can specified process channels separate processor cores increase analysis speed.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/manage_audio.html","id":"windowing","dir":"Articles","previous_headings":"Managing audio in R with SonicScrewdriveR","what":"Windowing","title":"Managing audio in R","text":"often desirable process long audio file chunks. windowing() function can used split audio file overlapping non-overlapping windows. function may particularly useful processing long Wave files memory-efficient manner. Optionally, cluster can specified process windows separate processor cores increase processing speed. order demonstrate windowing() first define simple function draws rectangle around windowed region sound file. can show windows generated window.length 44100 samples, window.overlap 0. entire audio file analysed chunks 44100 samples, overlap windows. drawWindow() function applied window, result plotted top oscillogram original audio file. window.overlap parameter can adjusted windows overlap certain number samples. Alternatively, negative value window.overlap can used take regularly-spaced samples audio file. bind.wave parameter can used combine results windowing function single Wave object (FUN returns Wave object). example use windowing() add noise sections sine wave.","code":"drawWindow <- function( wave, start, window.length) { rect(start, -1, start+window.length, 1, col= rgb(0,0,1.0,alpha=0.5)) } # Create a 5 second sine wave of 1Hz w <- tuneR::sine(1, duration=5*44100) plot(w@left, type=\"l\", xlab=\"Time (samples)\", ylab=\"Amplitude\") windowing(w, window.length=44100, window.overlap = 0, FUN=drawWindow) plot(w@left, type=\"l\", xlab=\"Time (samples)\", ylab=\"Amplitude\") windowing(w, window.length=44100, window.overlap = 44100/2, FUN=drawWindow) plot(w@left, type=\"l\", xlab=\"Time (samples)\", ylab=\"Amplitude\") windowing(w, window.length=44100, window.overlap = -44100, FUN=drawWindow) w <- tuneR::sine(1, duration=5*44100) addNoise <- function(w, start, window.length) { nw <- tuneR::noise(\"white\", duration=length(w@left), samp.rate=w@samp.rate, pcm=w@pcm, bit=w@bit) rw <- w + nw/max(nw@left) # Scale noise to the amplitude of the sine wave return(rw) } o <- windowing(w, window.length=44100, window.overlap = -44100, FUN=addNoise, bind.wave=TRUE) plot(o@left, type=\"l\", xlab=\"Time (samples)\", ylab=\"Amplitude\")"},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/manage_audio.html","id":"taggedwave-workflow","dir":"Articles","previous_headings":"","what":"TaggedWave workflow","title":"Managing audio in R","text":"techniques can applied generic Wave WaveMC objects tuneR package. TaggedWave class extends Wave class tuneR package can include extended metadata results analyses. allows storage additional information audio file, location time recording, results analyses. tagWave() function can used tag Wave WaveMC object additional metadata. addition, combined new classes WaveAugment, WaveFilter, WaveAnalyse possible create self-documenting pipeline audio processing analysis (also compatible R pipe).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/other-apps.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Interacting with other tools","text":"sonicscrewdriver package provides number functions interacting audio tools software. vignette provides overview functions available interacting tools.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/other-apps.html","id":"audacity","dir":"Articles","previous_headings":"Interfaces with other tools","what":"Audacity","title":"Interacting with other tools","text":"Label files exported Audacity can read R using readAudacityLabels() function. function takes path label file returns list Annotation objects data frame start end times label label text. writeAudacityLabels() function can used write list Annotation objects Audacity label file.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/other-apps.html","id":"audioblast","dir":"Articles","previous_headings":"Interfaces with other tools","what":"AudioBlast","title":"Interacting with other tools","text":"audioBlast API can accessed using audioBlast() function. Files can downloaded API using audioBlastDownload() function.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/other-apps.html","id":"audiomoth","dir":"Articles","previous_headings":"Interfaces with other tools","what":"AudioMoth","title":"Interacting with other tools","text":"AudioMoth configuration files wave files can read R using audiomothConfig() audiomothWave() functions, respectively. audiomothConfig() function takes path configuration file returns data frame configuration settings. audiomothWave() function takes path wave file returns list extracted parameters.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/other-apps.html","id":"birdnet-analyzer","dir":"Articles","previous_headings":"Interfaces with other tools","what":"BirdNET Analyzer","title":"Interacting with other tools","text":"BirdNET Analyzer deep learning model automatic detection bird sounds. birdNetInstall() function can used install ssd_birdnet environment required use birdNetAnalyse() function SonicScrewdriver. birdNetAnalyse() function takes list sound files analyses using BirdNET-Analyzer. function either returns data frame results analysis list Annotation objects.","code":"# Install the Python environment pythonInstall() # Analyse sound files using BirdNET-Analyzer f <- system.file(\"extdata\", \"AUDIOMOTH.WAV\", package=\"sonicscrewdriver\") birdNetAnalyse(f, lat=51.5, lon=0.1, date=as.Date(\"2021-01-01\"))"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/other-apps.html","id":"scikit-maad","dir":"Articles","previous_headings":"Interfaces with other tools","what":"scikit-maad","title":"Interacting with other tools","text":"scikit-maad open source Python package dedicated quantitative analysis environmental audio recordings. sonicscrewdriver makes use reticulate package create Python environment interact scikit-maad. sonicscrewdriver scikit-maad functions prefixed maad_. functions provided accept standard Wave-like objects (.e. tuneR Wave WaveMC objects, well tagged equivalents package).","code":"# Install the Python environment pythonInstall() f <- system.file(\"extdata\", \"AUDIOMOTH.WAV\", package=\"sonicscrewdriver\") w <- readWave(f) maad_aci <- maad_acoustic_complexity_index(w)"},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/other-apps.html","id":"audio-file-with-annotations-from-audioblast-to-audacity","dir":"Articles","previous_headings":"Exemplar applications","what":"Audio file with annotations from audioBlast to Audacity","title":"Interacting with other tools","text":"audio file interest (id: 10754) recording Mole Cricket Gryllotalpa vineae BioAcoustica repository. Recordings annotations BioAcoustica made available audioBlast API. First download audio file annotations audioBlast. downloaded audio file mole_cricket directory. also saved metadata.csv file includes information audio file retrieved audioBlast. Next, download annotations file audioBlast. downloaded annotations audioBlast converted list Annotation objects. annotation data converted Annotation objects can easily manipulated number useful formats. case, convert Annotation objects Audacity label file. finished, can tidy workspace removing mole_cricket directory.","code":"# Find the file on audioblast data <- audioblast(\"data\", \"recordings\", source=\"bio.acousti.ca\", id=10754) # Download the file to the mole_cricket directory audioblastDownload(data, dir=\"mole_cricket/\") # Fetch annotations from audioBlast as `Annotation` objects a <- audioblast(\"data\", \"annomate\", source=\"bio.acousti.ca\", id=10754, output=\"Annotations\") # Convert the annotations to an Audacity label file writeAudacityLabels(a, \"mole_cricket/annotations.txt\") unlink(\"mole_cricket\", recursive=TRUE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/other-apps.html","id":"birdnet-analyzer-to-audacity-label-file","dir":"Articles","previous_headings":"","what":"BirdNET Analyzer to Audacity label file","title":"Interacting with other tools","text":"birdNetAnalyse() function can used analyse sound files using BirdNET-Analyzer. Get output BirdNET Analyzer list Annotation objects. Convert Annotation objects Audacity label file. Cleaning workspace.","code":"# Analyse sound files using BirdNET-Analyzer f <- system.file(\"extdata\", \"AUDIOMOTH.WAV\", package=\"sonicscrewdriver\") annotations <- birdNetAnalyse(f, output=\"Annotation\") # Convert the annotations to an Audacity label file writeAudacityLabels(annotations, \"birdnet_annotations.txt\") unlink(\"birdnet_annotations.txt\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/sonicscrewdriver.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"SonicScrewdriveR","text":"SonicScrewdriveR set tools various tasks faced bioacoustics researchers (users acoustics). tools relate management, processing, analysis, visualisation audio recordings.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/test-signals.html","id":"introduction","dir":"Articles","previous_headings":"","what":"Introduction","title":"Generating acoustic test signals in R","text":"sonicscrewdriver package can used generate variety acoustic test signals.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/articles/test-signals.html","id":"sine-sweeps","dir":"Articles","previous_headings":"","what":"Sine sweeps","title":"Generating acoustic test signals in R","text":"sine sweep signal increases frequency time. sweptsine() function can used generate sine sweep signal. following example generates sine sweep signal starts 20 Hz ends 20 kHz. default linear sweeps generated, also possible generate logarithmic sweeps setting mode argument \"log\".","code":"sweep <- sweptsine(20, 20000) seewave::spectro(sweep) par(mfrow=c(2,1)) sweep <- sweptsine(1, 100) seewave::oscillo(sweep, title=\"Linear\") sweep <- sweptsine(1, 100, mode=\"log\") seewave::oscillo(sweep, title=\"Logarithmic\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Ed Baker. Author, maintainer. Quentin Geissman. Contributor.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Baker E (2021). SonicScrewdriveR. https://cran.r-project.org/package=sonicscrewdriver.","code":"@Manual{, title = {SonicScrewdriveR}, author = {Ed Baker}, year = {2021}, url = {https://cran.r-project.org/package=sonicscrewdriver}, }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/index.html","id":"sonicscrewdriver-","dir":"","previous_headings":"","what":"Bioacoustic Analysis and Publication Tools","title":"Bioacoustic Analysis and Publication Tools","text":"package provides tools manipulating sound files analysis visualisation. SonicScrewdriveR can: Easily read audio files many types. Work seamlessly multi-channel audio. Read/write/convert audio metadata formats used tools. Apply filters audio. Augment audio data machine learning. Visualise audio data. Create self-documenting analysis pipelines. need SonicScrewdriveR arose initially Automated Acoustic Observatories project University York, later development audioBlast. projects required ability read manipulate audio files variety formats visualise analyse data contained within . package designed flexible possible able handle audio file formats differing encoding, channel numbers, sample rates. one sense, can seen wrapper around existing packages provide unified interface, also offers many new functions visualisations.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/index.html","id":"cran","dir":"","previous_headings":"Installation","what":"CRAN","title":"Bioacoustic Analysis and Publication Tools","text":"","code":"install.packages(\"sonicscrewdriver\") library(sonicscrewdriver)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/index.html","id":"latest-master","dir":"","previous_headings":"Installation","what":"Latest master","title":"Bioacoustic Analysis and Publication Tools","text":"Development version documentation","code":"install.packages(\"devtools\") devtools::install_github(\"edwbaker/SonicScrewdriveR\") library(sonicscrewdriver)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"Bioacoustic Analysis and Publication Tools","text":"Usage package described following vignettes: Managing audio R SonicScrewdriveR covers basics reading audio files readAudio(), performing analyses audio channels using allChannels() performing analysis sections audio windowing(). Augmenting audio R SonicScrewdriveR covers audio data augmentation. Using apps tools R using SonicScrewdriveR lists functions available interface apps tools audioBlast, Audacity AudioMoth. also gives exemplar applications using SonicScrewdriveR move data different tools platforms. Using SonicScrewriveR audioBlast covers use audioblast() find recordings, annotations, traits analyses. audioblastDownload() can used download files find using audioBlast. book Visualisation bioacoustics ecoacoustics R provides details various visualisation tools available packages. Converting code work SonicScrewdriveR provides guidance package developers end users want convert code work SonicScrewdriveR types TaggedWave TaggedWaveMC.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/index.html","id":"contributing","dir":"","previous_headings":"","what":"Contributing","title":"Bioacoustic Analysis and Publication Tools","text":"welcome contributions anyone like help improve package. want talk us submitting pull request feel free email Ed edward.baker@nhm.ac.uk. Please note ‘SonicScrewdriveR’ project released Contributor Code Conduct.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/index.html","id":"issue-reporting","dir":"","previous_headings":"Contributing","what":"Issue reporting","title":"Bioacoustic Analysis and Publication Tools","text":"find bug, feature request, please report issue tracker many details possible. package fails give useful error message, bug. package accepts invalid input without warning, bug. documentation unclear omits important information, bug. unsure something bug, please report .","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/index.html","id":"credits","dir":"","previous_headings":"","what":"Credits","title":"Bioacoustic Analysis and Publication Tools","text":"Initial development SonicScrewdriveR done Ed Baker supported Leverhulme Trust funded Automated Acoustic Observatories project University York, later developed support analysis functionality audioBlast. SonicScrewdriveR currently developed Natural History Museum, London.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/Annotation-class.html","id":null,"dir":"Reference","previous_headings":"","what":"A S4 class for annotations — Annotation-class","title":"A S4 class for annotations — Annotation-class","text":"Annotation class used store annotations Wave-like objects.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/Annotation-class.html","id":"slots","dir":"Reference","previous_headings":"","what":"Slots","title":"A S4 class for annotations — Annotation-class","text":"file File annotated. metadata list storing metadata. start Start time annotation. end End time annotation. low Low frequency annotation. high High frequency annotation. source Source annotation. type Type annotation. value Value annotation.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/PseudoWave-class.html","id":null,"dir":"Reference","previous_headings":"","what":"An S4 class to represent a PseudoWave object that is converted to a Wave object when operated on. — PseudoWave-class","title":"An S4 class to represent a PseudoWave object that is converted to a Wave object when operated on. — PseudoWave-class","text":"S4 class represent PseudoWave object converted Wave object operated .","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/PseudoWave-class.html","id":"slots","dir":"Reference","previous_headings":"","what":"Slots","title":"An S4 class to represent a PseudoWave object that is converted to a Wave object when operated on. — PseudoWave-class","text":"type Type PseudoWave (e.g. \"noise\") subtype Subtype PseudoWave (e.g. \"white\" type \"noise\") scale Wave channels multiplied value offset value added Wave channels seed Random seed reproducible output, NA seed scale Logical. Whether use random seed value params List additional parameters pass generating function","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/PseudoWave-numeric-method.html","id":null,"dir":"Reference","previous_headings":"","what":"PseudoWave scalar subtraction — -,PseudoWave,numeric-method","title":"PseudoWave scalar subtraction — -,PseudoWave,numeric-method","text":"PseudoWave scalar subtraction","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/PseudoWave-numeric-method.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"PseudoWave scalar subtraction — -,PseudoWave,numeric-method","text":"","code":"# S4 method for class 'PseudoWave,numeric' e1 - e2"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/PseudoWave-numeric-method.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"PseudoWave scalar subtraction — -,PseudoWave,numeric-method","text":"e1 Input 1 e2 Input 2","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/STP.html","id":null,"dir":"Reference","previous_headings":"","what":"STP: Standard Temperature and Pressure — STP","title":"STP: Standard Temperature and Pressure — STP","text":"Dataset compiled various sources differing values STP.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/STP.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"STP: Standard Temperature and Pressure — STP","text":"","code":"STP"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/STP.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"STP: Standard Temperature and Pressure — STP","text":"object class list length 2.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/TaggedWave-class.html","id":null,"dir":"Reference","previous_headings":"","what":"A S4 class for tagged waves — TaggedWave-class","title":"A S4 class for tagged waves — TaggedWave-class","text":"TaggedWave class extended Wave class tuneR package can include extended metadata results analyses.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/TaggedWave-class.html","id":"slots","dir":"Reference","previous_headings":"","what":"Slots","title":"A S4 class for tagged waves — TaggedWave-class","text":"metadata list storing metadata. analyses list storing analyses.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/TaggedWaveMC-class.html","id":null,"dir":"Reference","previous_headings":"","what":"A S4 class for tagged multi-channel waves — TaggedWaveMC-class","title":"A S4 class for tagged multi-channel waves — TaggedWaveMC-class","text":"TaggedWaveMC class extended WaveMC class tuneR package can include extended metadata results analyses.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/TaggedWaveMC-class.html","id":"slots","dir":"Reference","previous_headings":"","what":"Slots","title":"A S4 class for tagged multi-channel waves — TaggedWaveMC-class","text":"metadata list storing metdata. analyses list storing analyses.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/TimeRegion-class.html","id":null,"dir":"Reference","previous_headings":"","what":"An S4 class to represent a TimeRegion within a Wave object. — TimeRegion-class","title":"An S4 class to represent a TimeRegion within a Wave object. — TimeRegion-class","text":"S4 class represent TimeRegion within Wave object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/TimeRegion-class.html","id":"slots","dir":"Reference","previous_headings":"","what":"Slots","title":"An S4 class to represent a TimeRegion within a Wave object. — TimeRegion-class","text":"Start position End position unit Time unit (one seconds, minutes, hours)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/WaveFilter-class.html","id":null,"dir":"Reference","previous_headings":"","what":"WaveFilter object for audio filters — WaveFilter-class","title":"WaveFilter object for audio filters — WaveFilter-class","text":"WaveFilter object object containing information necessary filterWave() function apply filter Wave TaggedWave object. designed allow pipe operator (either magrittr base R) used apply filters Wave pipeline. used TaggedWave object function adds information processing slot documenting action.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/WaveFilter-class.html","id":"slots","dir":"Reference","previous_headings":"","what":"Slots","title":"WaveFilter object for audio filters — WaveFilter-class","text":"description Description filter. func Name function. params List additional parameters pass function.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ab_diel_traits.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert text times of day in audioblast traits to numeric values — ab_diel_traits","title":"Convert text times of day in audioblast traits to numeric values — ab_diel_traits","text":"function takes traits dataset retrieved audioblast converts values \"day\" numeric time day based date location.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ab_diel_traits.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert text times of day in audioblast traits to numeric values — ab_diel_traits","text":"","code":"ab_diel_traits(traits, date, lat, lon, overwrite = FALSE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ab_diel_traits.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert text times of day in audioblast traits to numeric values — ab_diel_traits","text":"traits Traits dataset retrieved using audioblast(). date date used conversion time. lat Latitude location. lon Longitude location. overwrite TRUE function overwrite existing min/max.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/addProcess-methods.html","id":null,"dir":"Reference","previous_headings":"","what":"Add a process to a Tagged Wave or WaveMC object — addProcess","title":"Add a process to a Tagged Wave or WaveMC object — addProcess","text":"function takes TaggedWave TaggedWaveMC object adds process processing slot. used keep record processes applied object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/addProcess-methods.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add a process to a Tagged Wave or WaveMC object — addProcess","text":"","code":"addProcess(object, process, output = NULL, duration = NULL) # S4 method for class 'TaggedWave' addProcess(object, process, output = NULL, duration = NULL) # S4 method for class 'TaggedWaveMC' addProcess(object, process, output = NULL, duration = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/addProcess-methods.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add a process to a Tagged Wave or WaveMC object — addProcess","text":"object object. process description process. output output process. duration duration process seconds.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/addProcess-methods.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add a process to a Tagged Wave or WaveMC object — addProcess","text":"object process added.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/addSpectra.html","id":null,"dir":"Reference","previous_headings":"","what":"Add two spectra from seewave — addSpectra","title":"Add two spectra from seewave — addSpectra","text":"function takes two spectra seewave (equivalent) adds values. spectra must bins.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/addSpectra.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add two spectra from seewave — addSpectra","text":"","code":"addSpectra(s1, s2, coerceNegative = TRUE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/addSpectra.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add two spectra from seewave — addSpectra","text":"s1 First spectrum s2 Second spectrum coerceNegative Sets values zero zero output.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/addSpectra.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add two spectra from seewave — addSpectra","text":"spectrum s1+s2","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/addSpectra.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Add two spectra from seewave — addSpectra","text":"","code":"if (FALSE) { # \\dontrun{ subtractSpectra(spec1, spec2) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/allChannels.html","id":null,"dir":"Reference","previous_headings":"","what":"Apply a function to all channels of a Wave or WaveMC object — allChannels","title":"Apply a function to all channels of a Wave or WaveMC object — allChannels","text":"functions (e.g. ffilter seewave) operate single channel time. function applies function channel returns list analyses.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/allChannels.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Apply a function to all channels of a Wave or WaveMC object — allChannels","text":"","code":"allChannels( w, FUN, cl = NULL, channel.param = \"channel\", output.FUN = NULL, ... )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/allChannels.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Apply a function to all channels of a Wave or WaveMC object — allChannels","text":"w Wave WaveMC object FUN Function apply wave. cl Optionally cluster parallel calculation. channel.param Name channel parameter FUN. Can NULL. output.FUN Optional. Function processes output FUN. \"channels_se\" function provides standard functionality soundecology package. ... Optional. Additional parameters pass FUN.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/allChannels.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Apply a function to all channels of a Wave or WaveMC object — allChannels","text":"list outputs.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/annotation.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a new Annotation object — annotation","title":"Create a new Annotation object — annotation","text":"Create new Annotation object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/annotation.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a new Annotation object — annotation","text":"","code":"annotation( file = NA_character_, metadata = list(), start = 0, end = Inf, low = 0, high = Inf, source = NA_character_, type = NA_character_, value = NA_character_ )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/annotation.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a new Annotation object — annotation","text":"file File annotated. metadata list metadata. start Start time annotation (seconds). end End time annotation (seconds). low Low frequency annotation (Hz). high High frequency annotation (Hz). source Source annotation. type Type annotation. value Value annotation.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/annotation.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a new Annotation object — annotation","text":"Annotation object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audio_filesize.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculated size of raw audio files — audio_filesize","title":"Calculated size of raw audio files — audio_filesize","text":"Calculates raw size audio date set sample rate, bit depth duration.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audio_filesize.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculated size of raw audio files — audio_filesize","text":"","code":"audio_filesize( samp.rate = 44100, bit.depth = 16, channels = 1, duration = 1, duration.unit = \"seconds\", output.unit = \"bits\" )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audio_filesize.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculated size of raw audio files — audio_filesize","text":"samp.rate Sample rate bit.depth Bit depth channels number audio channels duration Duration recording duration.unit One seconds, minutes, hours, days output.unit \"human\", \"bits\" \"bytes\"","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audio_filesize.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Calculated size of raw audio files — audio_filesize","text":"size audio file specified unit","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audio_filesize.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Calculated size of raw audio files — audio_filesize","text":"default humanBytes() used convert output human readable format, however can changed setting output.unit \"bits\" \"bytes\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audio_filesize.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Calculated size of raw audio files — audio_filesize","text":"","code":"# One minute of mono 16-bit audio sampled at 44.1kHz audio_filesize(samp.rate=44100, bit.depth=16, channels=1, duration=1, duration.unit=\"minutes\") #> [1] 42336000 # One year of stereo 24-bit audio sampled at 96kHz audio_filesize(samp.rate=96000, bit.depth=24, channels=2, duration=1, duration.unit=\"years\") #> [1] 1.453179e+14"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audioblast.html","id":null,"dir":"Reference","previous_headings":"","what":"Get data or analyses from audioBlast — audioblast","title":"Get data or analyses from audioBlast — audioblast","text":"Search data analyses audioBlast.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audioblast.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get data or analyses from audioBlast — audioblast","text":"","code":"audioblast( type, name, endpoint = NULL, check = TRUE, max_pages = NULL, page = 1, quiet = FALSE, on.issue = stop, output = \"data.frame\", ... )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audioblast.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get data or analyses from audioBlast — audioblast","text":"type One data, analysis, standalone. name Name data analysis source. endpoint Optionally specify endpoint audioBlast module. check Logical. Performs sanity check input sending audioBLAST. max_pages Maximum number data pages return, default set NULL returns pages. page First page results request, defaults 1. quiet true print progress. Silence virtue. .issue Function call error warning. default stop raise standard R error. Setting warning instead warning. output default data.frame. \"Annotations\" return list Annotation objects. ... Fields values filter . field defined audioBLAST.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audioblast.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get data or analyses from audioBlast — audioblast","text":"data frame","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audioblast.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get data or analyses from audioBlast — audioblast","text":"","code":"if (FALSE) { # \\dontrun{ audioblast(\"data\", \"recordings\", taxon=\"Gryllotalpa vineae\") } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audioblastDownload.html","id":null,"dir":"Reference","previous_headings":"","what":"Download audio files from audioBlast — audioblastDownload","title":"Download audio files from audioBlast — audioblastDownload","text":"Downloads audio files associated search using audioBlast() function.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audioblastDownload.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download audio files from audioBlast — audioblastDownload","text":"","code":"audioblastDownload( d, metadata = TRUE, skip.existing = TRUE, dir = \".\", quiet = FALSE, on.issue = .audioblastIssue )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audioblastDownload.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download audio files from audioBlast — audioblastDownload","text":"d Data returned search using audioBlast(). metadata true saves data d csv file. skip.existing true overwrite existing files. dir Directory save files . quiet true print progress. .issue Function call error warning. default stop raise standard R error. Setting warning instead warning.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothConfig.html","id":null,"dir":"Reference","previous_headings":"","what":"Read AudioMoth configuration file — audiomothConfig","title":"Read AudioMoth configuration file — audiomothConfig","text":"Reads parses AudioMoth configuration file.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothConfig.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read AudioMoth configuration file — audiomothConfig","text":"","code":"audiomothConfig(filename)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothConfig.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read AudioMoth configuration file — audiomothConfig","text":"filename Path configuration file read","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothConfig.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read AudioMoth configuration file — audiomothConfig","text":"data frame matching annotations","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothConfig.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Read AudioMoth configuration file — audiomothConfig","text":"","code":"if (FALSE) { # \\dontrun{ audiomothConfig(\"./CONFIG.TXT\") } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothWave.html","id":null,"dir":"Reference","previous_headings":"","what":"Read AudioMoth metadata from a wave file — audiomothWave","title":"Read AudioMoth metadata from a wave file — audiomothWave","text":"Reads parses metadata stored wave files produced AudioMoth devices.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothWave.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read AudioMoth metadata from a wave file — audiomothWave","text":"","code":"audiomothWave(filename)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothWave.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read AudioMoth metadata from a wave file — audiomothWave","text":"filename Path wave file read","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothWave.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read AudioMoth metadata from a wave file — audiomothWave","text":"list extracted parameters","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/audiomothWave.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Read AudioMoth metadata from a wave file — audiomothWave","text":"","code":"if (FALSE) { # \\dontrun{ audiomothWave(\"./FILENAME.WAV\") } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/autoBandPass.html","id":null,"dir":"Reference","previous_headings":"","what":"Automatic Band Pass Filter — autoBandPass","title":"Automatic Band Pass Filter — autoBandPass","text":"Creates automatic bandpass filter based strongest frequency. allowed bandwidth can integer multiple bandwidth either -3dB -10dB.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/autoBandPass.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Automatic Band Pass Filter — autoBandPass","text":"","code":"autoBandPass(wave, bw = \"-3dB\", n.bw = 1, lowcut = 1000)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/autoBandPass.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Automatic Band Pass Filter — autoBandPass","text":"wave Wave object bw Either -3dB -10dB. calculated frequencyStats n.bw number bandwidths either side centre centre keep lowcut High-pass filtering applied frequency calculating centre frequency bandwidth","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/autoBandPass.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Automatic Band Pass Filter — autoBandPass","text":"band-pass filtered Wave object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/autoBandPass.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Automatic Band Pass Filter — autoBandPass","text":"","code":"if (FALSE) { # \\dontrun{ autoBandPass(sheep) autoBandPass(sheep, bw=\"-3dB\", n.bw=1, lowcut=1000) autoBandPass(sheep, bw=\"-10dB\", n.bw=2, lowcut=0) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/bandpass.html","id":null,"dir":"Reference","previous_headings":"","what":"Simple bandpass filter — bandpass","title":"Simple bandpass filter — bandpass","text":"Creates band pass WaveFilter values specified Wave object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/bandpass.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Simple bandpass filter — bandpass","text":"","code":"bandpass(from, to, ...)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/bandpass.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Simple bandpass filter — bandpass","text":"Bottom bandpass frequency (Hz). Top bandpass frequency (Hz). ... arguments pass ffilter.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/bandpass.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Simple bandpass filter — bandpass","text":"WaveFilter object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/bandpass.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Simple bandpass filter — bandpass","text":"simple wrapper function seewave ffilter function allowing use filterw pipes.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/bandpass.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Simple bandpass filter — bandpass","text":"","code":"if (FALSE) { # \\dontrun{ nwave <- noise(\"white\", duration=44100, samp.rate=44100) fwave <- filterWave(nwave, bandpass(from=1000, to=2000)) nwave |> filterWave(bandpass(from=1000, to=2000)) -> fwave } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatComplexity.html","id":null,"dir":"Reference","previous_headings":"","what":"Beat spectrum complexity — beatComplexity","title":"Beat spectrum complexity — beatComplexity","text":"function computes beatSpectrum calculates basic measurements complexity. complexity value calculated maximum identified repeating period (seconds) divided number peaks.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatComplexity.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Beat spectrum complexity — beatComplexity","text":"","code":"beatComplexity(wave, plot = FALSE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatComplexity.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Beat spectrum complexity — beatComplexity","text":"wave Wave object plot TRUE spectrogram overlaid peaks plotted.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatComplexity.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Beat spectrum complexity — beatComplexity","text":"list complexity, vector peak periods, number peaks.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatComplexity.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Beat spectrum complexity — beatComplexity","text":"","code":"if (FALSE) { # \\dontrun{ beatComplexity(sheep) beatComplexity(sheep, plot=TRUE) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatSpectrum.html","id":null,"dir":"Reference","previous_headings":"","what":"Computes a beat spectrum — beatSpectrum","title":"Computes a beat spectrum — beatSpectrum","text":"Beat spectra represent periodicity signal amplitude. computed performing continuous wavelet transform envelope preprocessed signal, processing average power per frequency band.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatSpectrum.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Computes a beat spectrum — beatSpectrum","text":"","code":"beatSpectrum(wave, min_period = 0.005, max_period = 30, dj = 1/32, ...)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatSpectrum.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Computes a beat spectrum — beatSpectrum","text":"wave R object path wave file min_period minimal rythmicity period expected, seconds max_period maximal rythmicity period expected, seconds dj frequency resolution cwt (voices per octave) ... extra arguments passed analyze.wavelet()","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatSpectrum.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Computes a beat spectrum — beatSpectrum","text":"spectrum data frame. contains two columns: power period. number rows depend resolution frequency range.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatSpectrum.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"Computes a beat spectrum — beatSpectrum","text":"Quentin Geissmann","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/beatSpectrum.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Computes a beat spectrum — beatSpectrum","text":"","code":"if (FALSE) { # \\dontrun{ beatSpectrum(sheep) beatSpectrum(sheep, min_period=0.005, max_period=30, dj=1/32) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/birdNetAnalyse.html","id":null,"dir":"Reference","previous_headings":"","what":"Analyse sound files using BirdNET-Analyzer — birdNetAnalyse","title":"Analyse sound files using BirdNET-Analyzer — birdNetAnalyse","text":"function takes list sound files analyses using BirdNET-Analyzer birdnet2021sonicscrewdriver. function either returns data frame results analysis list Annotation objects.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/birdNetAnalyse.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Analyse sound files using BirdNET-Analyzer — birdNetAnalyse","text":"","code":"birdNetAnalyse( files, lat = NULL, lon = NULL, date = NULL, output = \"Annotation\" )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/birdNetAnalyse.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Analyse sound files using BirdNET-Analyzer — birdNetAnalyse","text":"files character vector file paths. lat latitude vector latitudes. lon longitude vector longitudes. date Date list Date objects . output One \"data.frame\" \"Annotation\".","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/birdNetAnalyse.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Analyse sound files using BirdNET-Analyzer — birdNetAnalyse","text":"","code":"if (FALSE) { # \\dontrun{ birdnetAnalyse(files=c(\"path/to/file1.wav\", \"path/to/file2.wav\"), output=\"data.frame\") } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/channels_se.html","id":null,"dir":"Reference","previous_headings":"","what":"Channels for sound ecology — channels_se","title":"Channels for sound ecology — channels_se","text":"Used process output acoustic index functions soundecology package using allChannels.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/channels_se.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Channels for sound ecology — channels_se","text":"","code":"channels_se(...)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/channels_se.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Channels for sound ecology — channels_se","text":"... Export bioacoustic index function soundecology package","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/circularise.html","id":null,"dir":"Reference","previous_headings":"","what":"Circularise a dataset — circularise","title":"Circularise a dataset — circularise","text":"plotting rings horizons meant cover entirety time period dielPlot() yearlyPlot() function append beginning values end ensure entire loop created.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/circularise.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Circularise a dataset — circularise","text":"","code":"circularise(values)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/circularise.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Circularise a dataset — circularise","text":"values vector values","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/concat-methods.html","id":null,"dir":"Reference","previous_headings":"","what":"Concatenate two or more Wave-like objects. — concat","title":"Concatenate two or more Wave-like objects. — concat","text":"concat() method flexible version bind() method tuneR package, allows specifying advanced types concatenation. Setting method \"noClick\" remove click Wave objects caused sudden jumps amplitude applying tuneR::prepComb() appropriately default value zero (effective left channel stereo multi-channel recordings).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/concat-methods.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Concatenate two or more Wave-like objects. — concat","text":"","code":"concat(object, ..., method = \"bind\") # S4 method for class 'Wave' concat(object, ..., method = \"bind\") # S4 method for class 'WaveMC' concat(object, ..., method = \"bind\") # S4 method for class 'TaggedWave' concat(object, ..., method = \"bind\") # S4 method for class 'TaggedWaveMC' concat(object, ..., method = \"bind\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/concat-methods.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Concatenate two or more Wave-like objects. — concat","text":"object Wave like object. ... Wave like objects concatenate object. method One \"bind\", \"noClick\". Default \"bind\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/concat-methods.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Concatenate two or more Wave-like objects. — concat","text":"concatenated Wave like object, type object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Celsius.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert temperature to Celsius — convert2Celsius","title":"Convert temperature to Celsius — convert2Celsius","text":"Converts temperature measurements Celsius","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Celsius.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert temperature to Celsius — convert2Celsius","text":"","code":"convert2Celsius(temp, input = \"K\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Celsius.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert temperature to Celsius — convert2Celsius","text":"temp value temperature convert input unit temperature convert, allowed values \"K\", \"F\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Celsius.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert temperature to Celsius — convert2Celsius","text":"Numeric value degrees Celsius","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Celsius.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert temperature to Celsius — convert2Celsius","text":"","code":"convert2Celsius(15, input=\"K\") #> [1] -258.15 convert2Celsius(15, input=\"F\") #> [1] -9.444444"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Fahrenheit.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert temperature to Fahrenheit — convert2Fahrenheit","title":"Convert temperature to Fahrenheit — convert2Fahrenheit","text":"Converts temperature measurements Fahrenheit","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Fahrenheit.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert temperature to Fahrenheit — convert2Fahrenheit","text":"","code":"convert2Fahrenheit(temp, input)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Fahrenheit.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert temperature to Fahrenheit — convert2Fahrenheit","text":"temp value temperature convert input unit temperature convert, allowed values \"K\", \"C\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Fahrenheit.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert temperature to Fahrenheit — convert2Fahrenheit","text":"","code":"if (FALSE) { # \\dontrun{ convert2Fahrenheit(15, input = \"C\") } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Kelvin.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert temperature to Kelvin — convert2Kelvin","title":"Convert temperature to Kelvin — convert2Kelvin","text":"Converts temperature measurements Kelvin","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Kelvin.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert temperature to Kelvin — convert2Kelvin","text":"","code":"convert2Kelvin(temp, input = \"C\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Kelvin.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert temperature to Kelvin — convert2Kelvin","text":"temp value temperature convert input unit temperature convert, allowed values \"C\", \"F\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Kelvin.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert temperature to Kelvin — convert2Kelvin","text":"Numeric value Kelvin","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Kelvin.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert temperature to Kelvin — convert2Kelvin","text":"","code":"convert2Kelvin(15, input=\"C\") #> [1] 288.15 convert2Kelvin(15, input=\"F\") #> [1] 263.7056"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Pascals.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert pressure to Pascals — convert2Pascals","title":"Convert pressure to Pascals — convert2Pascals","text":"Converts pressure measurements Pascals","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Pascals.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert pressure to Pascals — convert2Pascals","text":"","code":"convert2Pascals(P, input = \"kPa\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Pascals.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert pressure to Pascals — convert2Pascals","text":"P value pressure convert input unit pressure convert, allowed values \"kPa\", \"dyne_cm2\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Pascals.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert pressure to Pascals — convert2Pascals","text":"numeric value Pascals","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2Pascals.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert pressure to Pascals — convert2Pascals","text":"","code":"convert2Pascals(1000, input=\"kPa\") #> [1] 1e+06 convert2Pascals(10, input=\"dyne_cm2\") #> [1] 1"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2bytes.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert bits to bytes — convert2bytes","title":"Convert bits to bytes — convert2bytes","text":"Converts time measurements seconds","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2bytes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert bits to bytes — convert2bytes","text":"","code":"convert2bytes(S, input = \"bits\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2bytes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert bits to bytes — convert2bytes","text":"S value convert input unit convert, allowed values \"bits\", \"kB\", \"MB\", \"GB\"","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2bytes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert bits to bytes — convert2bytes","text":"numeric value seconds","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2degrees.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert angle to degrees — convert2degrees","title":"Convert angle to degrees — convert2degrees","text":"Converts angle measurements degrees","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2degrees.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert angle to degrees — convert2degrees","text":"","code":"convert2degrees(A, input = \"radians\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2degrees.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert angle to degrees — convert2degrees","text":"angle value convert input unit angle convert, allowed values \"radians\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2degrees.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert angle to degrees — convert2degrees","text":"numeric value degrees","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2dyne_cm2.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert pressure to dyne per square centimetre — convert2dyne_cm2","title":"Convert pressure to dyne per square centimetre — convert2dyne_cm2","text":"Converts pressure measurements dyne per square centimetre","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2dyne_cm2.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert pressure to dyne per square centimetre — convert2dyne_cm2","text":"","code":"convert2dyne_cm2(P, input = \"kPa\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2dyne_cm2.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert pressure to dyne per square centimetre — convert2dyne_cm2","text":"P value pressure convert input unit pressure convert, allowed values \"kPa\", \"P\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2dyne_cm2.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert pressure to dyne per square centimetre — convert2dyne_cm2","text":"","code":"convert2dyne_cm2(1, input=\"Pa\") #> [1] 10 convert2dyne_cm2(1, input=\"kPa\") #> [1] 10000"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2radians.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert angle to radians — convert2radians","title":"Convert angle to radians — convert2radians","text":"Converts angle measurements radians","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2radians.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert angle to radians — convert2radians","text":"","code":"convert2radians(A, input = \"degrees\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2radians.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert angle to radians — convert2radians","text":"angle value convert input unit angle convert, allowed values \"degrees\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2radians.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert angle to radians — convert2radians","text":"numeric value radians","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2seconds.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert time to seconds — convert2seconds","title":"Convert time to seconds — convert2seconds","text":"Converts time measurements seconds","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2seconds.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert time to seconds — convert2seconds","text":"","code":"convert2seconds(T, input = \"minutes\", origin = \"day\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2seconds.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert time to seconds — convert2seconds","text":"T time value convert input unit time convert, allowed values \"minutes\", \"hours\", \"days\", \"years\", \"HHMM\". origin POSIX whether return relative start day (\"day\") Unix epoch (\"unix\")","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/convert2seconds.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert time to seconds — convert2seconds","text":"numeric value seconds","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/corWaveMC.html","id":null,"dir":"Reference","previous_headings":"","what":"Correlate channels in a WaveMC object — corWaveMC","title":"Correlate channels in a WaveMC object — corWaveMC","text":"Uses corenv function seewave calculate envelope correlation timed events channels WaveMC object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/corWaveMC.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Correlate channels in a WaveMC object — corWaveMC","text":"","code":"corWaveMC(wave, times, window, temp = 25, cluster = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/corWaveMC.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Correlate channels in a WaveMC object — corWaveMC","text":"wave WaveMC object times One times events correlate window Width window correlate seconds (centred times) temp Air temperature Celsius cluster cluster parallel execution","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/corWaveMC.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Correlate channels in a WaveMC object — corWaveMC","text":"List corenv lists events, list time differences channels","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/cutws.html","id":null,"dir":"Reference","previous_headings":"","what":"Cut wave by samples — cutws","title":"Cut wave by samples — cutws","text":"Extract section Wave object based sample positions. function automatically detect Wave object stereo.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/cutws.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Cut wave by samples — cutws","text":"","code":"cutws(wave, from = 1, to = Inf, plot = FALSE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/cutws.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Cut wave by samples — cutws","text":"wave Wave object First sample return Last sample return plot TRUE shows cut region within original waveform","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/cutws.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Cut wave by samples — cutws","text":"Wave object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/cutws.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Cut wave by samples — cutws","text":"","code":"if (FALSE) { # \\dontrun{ cutws(sheep, 1, 20) cutws(sheep, 1, 20, plot=TRUE) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/data2Wave.html","id":null,"dir":"Reference","previous_headings":"","what":"Convert data into a Wave object — data2Wave","title":"Convert data into a Wave object — data2Wave","text":"Make sequence data normalised Wave object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/data2Wave.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Convert data into a Wave object — data2Wave","text":"","code":"data2Wave( left, samp.rate = 44100, bit = 16, unit = NULL, remove.offset = TRUE, normalise = TRUE )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/data2Wave.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Convert data into a Wave object — data2Wave","text":"left Data mono audio channel samp.rate Sampling rate Wave object bit Bit depth Wave object unit See tuneR::normalize. NULL handled automatically. remove.offset TRUE DC offset removed normalise TRUE output Wave normalised -1:1","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/data2Wave.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Convert data into a Wave object — data2Wave","text":"mono Wave object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/data2Wave.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Convert data into a Wave object — data2Wave","text":"","code":"pattern <- seq(from=-1, to=1, length.out=100) data <- rep.int(pattern, 100) w <- data2Wave(data)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dayPhase.html","id":null,"dir":"Reference","previous_headings":"","what":"Phase of day — dayPhase","title":"Phase of day — dayPhase","text":"Given start time (optionally) duration returns phase day given location. primarily used calculate phase day information soundscape recording projects.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dayPhase.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Phase of day — dayPhase","text":"","code":"dayPhase( time = Sys.time(), duration = 40000, lat = 50.1, lon = 1.83, tz = \"UTC\" )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dayPhase.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Phase of day — dayPhase","text":"time time object representing start time recording duration Duration recording lat Latitude recording device lon Longitude recording device tz Time-zone recording device recording made","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dayPhase.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Phase of day — dayPhase","text":"Data frame day phases absolute timestamps relative times within file","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dayPhases.html","id":null,"dir":"Reference","previous_headings":"","what":"Phases of day — dayPhases","title":"Phases of day — dayPhases","text":"Wrapper suncalc::getSunlightTimes formats output package.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dayPhases.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Phases of day — dayPhases","text":"","code":"dayPhases(time = as.Date(Sys.time()), lat = 50.1, lon = 1.83, tz = \"UTC\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dayPhases.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Phases of day — dayPhases","text":"time time object representing start time recording lat Latitude recording device lon Longitude recording device tz Time-zone recording device recording made","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/daysPhases.html","id":null,"dir":"Reference","previous_headings":"","what":"Phases of days — daysPhases","title":"Phases of days — daysPhases","text":"Phases days","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/daysPhases.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Phases of days — daysPhases","text":"","code":"daysPhases( date = Sys.Date(), period = \"year\", plot = FALSE, lat = 50.1, lon = 1.83, tz = \"UTC\" )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/daysPhases.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Phases of days — daysPhases","text":"date time object representing start time recording period \"month\" \"year\" plot true plots data, default FALSE lat Latitude recording device lon Longitude recording device tz Time-zone recording device recording made","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/defaultCluster.html","id":null,"dir":"Reference","previous_headings":"","what":"Create Default Cluster for Windowing — defaultCluster","title":"Create Default Cluster for Windowing — defaultCluster","text":"Creates default cluster using one less total cores available system. default uses forking, available Windows. Hence, fork parameter effect Windows.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/defaultCluster.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create Default Cluster for Windowing — defaultCluster","text":"","code":"defaultCluster(fork = TRUE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/defaultCluster.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create Default Cluster for Windowing — defaultCluster","text":"fork TRUE uses forking create cluster (Unix like systems )","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/defaultCluster.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create Default Cluster for Windowing — defaultCluster","text":"cluster object parallel processing","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/defaultCluster.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create Default Cluster for Windowing — defaultCluster","text":"","code":"if (FALSE) { # \\dontrun{ cl <- defaultCluster() stopCluster(cl) cl <- defaultCluster(FALSE) stopCluster(cl) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielFraction.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate the fraction of a day given by a value — dielFraction","title":"Calculate the fraction of a day given by a value — dielFraction","text":"Given object can coerced POSIXlt supported string format, return fraction day represented object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielFraction.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate the fraction of a day given by a value — dielFraction","text":"","code":"dielFraction(t, input = \"POSIX\", unit = \"radians\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielFraction.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate the fraction of a day given by a value — dielFraction","text":"t Object converted fraction input One POSIX (default) HHMM unit set radians outputs position around circle. set fraction outputs raw fraction.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielHistogram.html","id":null,"dir":"Reference","previous_headings":"","what":"Diel Histogram — dielHistogram","title":"Diel Histogram — dielHistogram","text":"Draws histogram dielPlot() using pre-defined bins related time day.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielHistogram.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Diel Histogram — dielHistogram","text":"","code":"dielHistogram( times, by = \"hour\", col = \"grey\", maxval = NA, presence.only = FALSE, limits = c(1, 2) )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielHistogram.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Diel Histogram — dielHistogram","text":"times vector times can pocessed dielFraction(). Controls size histogram bins, one \"hour\", \"15minute\", \"30minute\". col Colour plot. maxval default scales histogram within limits, specifying maximum value allows comparison plots. presence.show presence/absence values. limits Limits plotting (see dielPlot()).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielHistogram.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Diel Histogram — dielHistogram","text":"data frame start end points bins.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielLabels.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate labels for a diel plot — dielLabels","title":"Generate labels for a diel plot — dielLabels","text":"Generates labels dielPlot() 12- 24-hour format. Labels generated three hourly intervals.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielLabels.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate labels for a diel plot — dielLabels","text":"","code":"dielLabels(format = \"clock24\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielLabels.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate labels for a diel plot — dielLabels","text":"format One clock24 (default) clock12","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielLabels.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate labels for a diel plot — dielLabels","text":"","code":"dielLabels() #> [1] \"0000\" \"0300\" \"0600\" \"0900\" \"1200\" \"1500\" \"1800\" \"2100\" dielLabels(\"clock12\") #> [1] \"0000\" \"0300 AM\" \"0600 AM\" \"0900 AM\" \"1200 NOON\" \"0300 PM\" #> [7] \"0600 PM\" \"0900 PM\""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielPlot.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a diel plot — dielPlot","title":"Create a diel plot — dielPlot","text":"diel plot shows times night, twilight maximum altitude sun given date.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielPlot.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a diel plot — dielPlot","text":"","code":"dielPlot( date, lat, lon, limits = c(0, 2), plot = NULL, rot = tzRot(0), method = \"plotrix\", legend = F )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielPlot.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a diel plot — dielPlot","text":"date Date plot. lat Numeric latitude. lon Numeric longitude. limits Plotting limits daylight regions, default c(1,2) plot Character vector components plot rot Either \"Solar Noon\" offset calculated tz method Plotting library use legend Whether show legend","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielPositions.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate positions of labels for a diel plot — dielPositions","title":"Generate positions of labels for a diel plot — dielPositions","text":"Generates positions three-hourly labels dielPlot() radians.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielPositions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate positions of labels for a diel plot — dielPositions","text":"","code":"dielPositions(format = \"3hourly\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielPositions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate positions of labels for a diel plot — dielPositions","text":"format One \"3hours\" (default), \"hours\", \"minutes\"","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielPositions.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate positions of labels for a diel plot — dielPositions","text":"","code":"dielPositions() #> [1] 0.0000000 0.7853982 1.5707963 2.3561945 3.1415927 3.9269908 4.7123890 #> [8] 5.4977871 dielPositions(\"hours\") #> [1] 0.2617994 0.5235988 0.7853982 1.0471976 1.3089969 1.5707963 1.8325957 #> [8] 2.0943951 2.3561945 2.6179939 2.8797933 3.1415927 3.4033920 3.6651914 #> [15] 3.9269908 4.1887902 4.4505896 4.7123890 4.9741884 5.2359878 5.4977871 #> [22] 5.7595865 6.0213859 6.2831853 dielPositions(\"minutes\") #> [1] 0.004363323 0.008726646 0.013089969 0.017453293 0.021816616 0.026179939 #> [7] 0.030543262 0.034906585 0.039269908 0.043633231 0.047996554 0.052359878 #> [13] 0.056723201 0.061086524 0.065449847 0.069813170 0.074176493 0.078539816 #> [19] 0.082903139 0.087266463 0.091629786 0.095993109 0.100356432 0.104719755 #> [25] 0.109083078 0.113446401 0.117809725 0.122173048 0.126536371 0.130899694 #> [31] 0.135263017 0.139626340 0.143989663 0.148352986 0.152716310 0.157079633 #> [37] 0.161442956 0.165806279 0.170169602 0.174532925 0.178896248 0.183259571 #> [43] 0.187622895 0.191986218 0.196349541 0.200712864 0.205076187 0.209439510 #> [49] 0.213802833 0.218166156 0.222529480 0.226892803 0.231256126 0.235619449 #> [55] 0.239982772 0.244346095 0.248709418 0.253072742 0.257436065 0.261799388 #> [61] 0.266162711 0.270526034 0.274889357 0.279252680 0.283616003 0.287979327 #> [67] 0.292342650 0.296705973 0.301069296 0.305432619 0.309795942 0.314159265 #> [73] 0.318522588 0.322885912 0.327249235 0.331612558 0.335975881 0.340339204 #> [79] 0.344702527 0.349065850 0.353429174 0.357792497 0.362155820 0.366519143 #> [85] 0.370882466 0.375245789 0.379609112 0.383972435 0.388335759 0.392699082 #> [91] 0.397062405 0.401425728 0.405789051 0.410152374 0.414515697 0.418879020 #> [97] 0.423242344 0.427605667 0.431968990 0.436332313 0.440695636 0.445058959 #> [103] 0.449422282 0.453785606 0.458148929 0.462512252 0.466875575 0.471238898 #> [109] 0.475602221 0.479965544 0.484328867 0.488692191 0.493055514 0.497418837 #> [115] 0.501782160 0.506145483 0.510508806 0.514872129 0.519235452 0.523598776 #> [121] 0.527962099 0.532325422 0.536688745 0.541052068 0.545415391 0.549778714 #> [127] 0.554142038 0.558505361 0.562868684 0.567232007 0.571595330 0.575958653 #> [133] 0.580321976 0.584685299 0.589048623 0.593411946 0.597775269 0.602138592 #> [139] 0.606501915 0.610865238 0.615228561 0.619591884 0.623955208 0.628318531 #> [145] 0.632681854 0.637045177 0.641408500 0.645771823 0.650135146 0.654498469 #> [151] 0.658861793 0.663225116 0.667588439 0.671951762 0.676315085 0.680678408 #> [157] 0.685041731 0.689405055 0.693768378 0.698131701 0.702495024 0.706858347 #> [163] 0.711221670 0.715584993 0.719948316 0.724311640 0.728674963 0.733038286 #> [169] 0.737401609 0.741764932 0.746128255 0.750491578 0.754854901 0.759218225 #> [175] 0.763581548 0.767944871 0.772308194 0.776671517 0.781034840 0.785398163 #> [181] 0.789761487 0.794124810 0.798488133 0.802851456 0.807214779 0.811578102 #> [187] 0.815941425 0.820304748 0.824668072 0.829031395 0.833394718 0.837758041 #> [193] 0.842121364 0.846484687 0.850848010 0.855211333 0.859574657 0.863937980 #> [199] 0.868301303 0.872664626 0.877027949 0.881391272 0.885754595 0.890117919 #> [205] 0.894481242 0.898844565 0.903207888 0.907571211 0.911934534 0.916297857 #> [211] 0.920661180 0.925024504 0.929387827 0.933751150 0.938114473 0.942477796 #> [217] 0.946841119 0.951204442 0.955567765 0.959931089 0.964294412 0.968657735 #> [223] 0.973021058 0.977384381 0.981747704 0.986111027 0.990474351 0.994837674 #> [229] 0.999200997 1.003564320 1.007927643 1.012290966 1.016654289 1.021017612 #> [235] 1.025380936 1.029744259 1.034107582 1.038470905 1.042834228 1.047197551 #> [241] 1.051560874 1.055924197 1.060287521 1.064650844 1.069014167 1.073377490 #> [247] 1.077740813 1.082104136 1.086467459 1.090830782 1.095194106 1.099557429 #> [253] 1.103920752 1.108284075 1.112647398 1.117010721 1.121374044 1.125737368 #> [259] 1.130100691 1.134464014 1.138827337 1.143190660 1.147553983 1.151917306 #> [265] 1.156280629 1.160643953 1.165007276 1.169370599 1.173733922 1.178097245 #> [271] 1.182460568 1.186823891 1.191187214 1.195550538 1.199913861 1.204277184 #> [277] 1.208640507 1.213003830 1.217367153 1.221730476 1.226093800 1.230457123 #> [283] 1.234820446 1.239183769 1.243547092 1.247910415 1.252273738 1.256637061 #> [289] 1.261000385 1.265363708 1.269727031 1.274090354 1.278453677 1.282817000 #> [295] 1.287180323 1.291543646 1.295906970 1.300270293 1.304633616 1.308996939 #> [301] 1.313360262 1.317723585 1.322086908 1.326450232 1.330813555 1.335176878 #> [307] 1.339540201 1.343903524 1.348266847 1.352630170 1.356993493 1.361356817 #> [313] 1.365720140 1.370083463 1.374446786 1.378810109 1.383173432 1.387536755 #> [319] 1.391900078 1.396263402 1.400626725 1.404990048 1.409353371 1.413716694 #> [325] 1.418080017 1.422443340 1.426806664 1.431169987 1.435533310 1.439896633 #> [331] 1.444259956 1.448623279 1.452986602 1.457349925 1.461713249 1.466076572 #> [337] 1.470439895 1.474803218 1.479166541 1.483529864 1.487893187 1.492256510 #> [343] 1.496619834 1.500983157 1.505346480 1.509709803 1.514073126 1.518436449 #> [349] 1.522799772 1.527163095 1.531526419 1.535889742 1.540253065 1.544616388 #> [355] 1.548979711 1.553343034 1.557706357 1.562069681 1.566433004 1.570796327 #> [361] 1.575159650 1.579522973 1.583886296 1.588249619 1.592612942 1.596976266 #> [367] 1.601339589 1.605702912 1.610066235 1.614429558 1.618792881 1.623156204 #> [373] 1.627519527 1.631882851 1.636246174 1.640609497 1.644972820 1.649336143 #> [379] 1.653699466 1.658062789 1.662426113 1.666789436 1.671152759 1.675516082 #> [385] 1.679879405 1.684242728 1.688606051 1.692969374 1.697332698 1.701696021 #> [391] 1.706059344 1.710422667 1.714785990 1.719149313 1.723512636 1.727875959 #> [397] 1.732239283 1.736602606 1.740965929 1.745329252 1.749692575 1.754055898 #> [403] 1.758419221 1.762782545 1.767145868 1.771509191 1.775872514 1.780235837 #> [409] 1.784599160 1.788962483 1.793325806 1.797689130 1.802052453 1.806415776 #> [415] 1.810779099 1.815142422 1.819505745 1.823869068 1.828232391 1.832595715 #> [421] 1.836959038 1.841322361 1.845685684 1.850049007 1.854412330 1.858775653 #> [427] 1.863138977 1.867502300 1.871865623 1.876228946 1.880592269 1.884955592 #> [433] 1.889318915 1.893682238 1.898045562 1.902408885 1.906772208 1.911135531 #> [439] 1.915498854 1.919862177 1.924225500 1.928588823 1.932952147 1.937315470 #> [445] 1.941678793 1.946042116 1.950405439 1.954768762 1.959132085 1.963495408 #> [451] 1.967858732 1.972222055 1.976585378 1.980948701 1.985312024 1.989675347 #> [457] 1.994038670 1.998401994 2.002765317 2.007128640 2.011491963 2.015855286 #> [463] 2.020218609 2.024581932 2.028945255 2.033308579 2.037671902 2.042035225 #> [469] 2.046398548 2.050761871 2.055125194 2.059488517 2.063851840 2.068215164 #> [475] 2.072578487 2.076941810 2.081305133 2.085668456 2.090031779 2.094395102 #> [481] 2.098758426 2.103121749 2.107485072 2.111848395 2.116211718 2.120575041 #> [487] 2.124938364 2.129301687 2.133665011 2.138028334 2.142391657 2.146754980 #> [493] 2.151118303 2.155481626 2.159844949 2.164208272 2.168571596 2.172934919 #> [499] 2.177298242 2.181661565 2.186024888 2.190388211 2.194751534 2.199114858 #> [505] 2.203478181 2.207841504 2.212204827 2.216568150 2.220931473 2.225294796 #> [511] 2.229658119 2.234021443 2.238384766 2.242748089 2.247111412 2.251474735 #> [517] 2.255838058 2.260201381 2.264564704 2.268928028 2.273291351 2.277654674 #> [523] 2.282017997 2.286381320 2.290744643 2.295107966 2.299471290 2.303834613 #> [529] 2.308197936 2.312561259 2.316924582 2.321287905 2.325651228 2.330014551 #> [535] 2.334377875 2.338741198 2.343104521 2.347467844 2.351831167 2.356194490 #> [541] 2.360557813 2.364921136 2.369284460 2.373647783 2.378011106 2.382374429 #> [547] 2.386737752 2.391101075 2.395464398 2.399827721 2.404191045 2.408554368 #> [553] 2.412917691 2.417281014 2.421644337 2.426007660 2.430370983 2.434734307 #> [559] 2.439097630 2.443460953 2.447824276 2.452187599 2.456550922 2.460914245 #> [565] 2.465277568 2.469640892 2.474004215 2.478367538 2.482730861 2.487094184 #> [571] 2.491457507 2.495820830 2.500184153 2.504547477 2.508910800 2.513274123 #> [577] 2.517637446 2.522000769 2.526364092 2.530727415 2.535090739 2.539454062 #> [583] 2.543817385 2.548180708 2.552544031 2.556907354 2.561270677 2.565634000 #> [589] 2.569997324 2.574360647 2.578723970 2.583087293 2.587450616 2.591813939 #> [595] 2.596177262 2.600540585 2.604903909 2.609267232 2.613630555 2.617993878 #> [601] 2.622357201 2.626720524 2.631083847 2.635447171 2.639810494 2.644173817 #> [607] 2.648537140 2.652900463 2.657263786 2.661627109 2.665990432 2.670353756 #> [613] 2.674717079 2.679080402 2.683443725 2.687807048 2.692170371 2.696533694 #> [619] 2.700897017 2.705260341 2.709623664 2.713986987 2.718350310 2.722713633 #> [625] 2.727076956 2.731440279 2.735803603 2.740166926 2.744530249 2.748893572 #> [631] 2.753256895 2.757620218 2.761983541 2.766346864 2.770710188 2.775073511 #> [637] 2.779436834 2.783800157 2.788163480 2.792526803 2.796890126 2.801253449 #> [643] 2.805616773 2.809980096 2.814343419 2.818706742 2.823070065 2.827433388 #> [649] 2.831796711 2.836160034 2.840523358 2.844886681 2.849250004 2.853613327 #> [655] 2.857976650 2.862339973 2.866703296 2.871066620 2.875429943 2.879793266 #> [661] 2.884156589 2.888519912 2.892883235 2.897246558 2.901609881 2.905973205 #> [667] 2.910336528 2.914699851 2.919063174 2.923426497 2.927789820 2.932153143 #> [673] 2.936516466 2.940879790 2.945243113 2.949606436 2.953969759 2.958333082 #> [679] 2.962696405 2.967059728 2.971423052 2.975786375 2.980149698 2.984513021 #> [685] 2.988876344 2.993239667 2.997602990 3.001966313 3.006329637 3.010692960 #> [691] 3.015056283 3.019419606 3.023782929 3.028146252 3.032509575 3.036872898 #> [697] 3.041236222 3.045599545 3.049962868 3.054326191 3.058689514 3.063052837 #> [703] 3.067416160 3.071779484 3.076142807 3.080506130 3.084869453 3.089232776 #> [709] 3.093596099 3.097959422 3.102322745 3.106686069 3.111049392 3.115412715 #> [715] 3.119776038 3.124139361 3.128502684 3.132866007 3.137229330 3.141592654 #> [721] 3.145955977 3.150319300 3.154682623 3.159045946 3.163409269 3.167772592 #> [727] 3.172135915 3.176499239 3.180862562 3.185225885 3.189589208 3.193952531 #> [733] 3.198315854 3.202679177 3.207042501 3.211405824 3.215769147 3.220132470 #> [739] 3.224495793 3.228859116 3.233222439 3.237585762 3.241949086 3.246312409 #> [745] 3.250675732 3.255039055 3.259402378 3.263765701 3.268129024 3.272492347 #> [751] 3.276855671 3.281218994 3.285582317 3.289945640 3.294308963 3.298672286 #> [757] 3.303035609 3.307398933 3.311762256 3.316125579 3.320488902 3.324852225 #> [763] 3.329215548 3.333578871 3.337942194 3.342305518 3.346668841 3.351032164 #> [769] 3.355395487 3.359758810 3.364122133 3.368485456 3.372848779 3.377212103 #> [775] 3.381575426 3.385938749 3.390302072 3.394665395 3.399028718 3.403392041 #> [781] 3.407755365 3.412118688 3.416482011 3.420845334 3.425208657 3.429571980 #> [787] 3.433935303 3.438298626 3.442661950 3.447025273 3.451388596 3.455751919 #> [793] 3.460115242 3.464478565 3.468841888 3.473205211 3.477568535 3.481931858 #> [799] 3.486295181 3.490658504 3.495021827 3.499385150 3.503748473 3.508111797 #> [805] 3.512475120 3.516838443 3.521201766 3.525565089 3.529928412 3.534291735 #> [811] 3.538655058 3.543018382 3.547381705 3.551745028 3.556108351 3.560471674 #> [817] 3.564834997 3.569198320 3.573561643 3.577924967 3.582288290 3.586651613 #> [823] 3.591014936 3.595378259 3.599741582 3.604104905 3.608468228 3.612831552 #> [829] 3.617194875 3.621558198 3.625921521 3.630284844 3.634648167 3.639011490 #> [835] 3.643374814 3.647738137 3.652101460 3.656464783 3.660828106 3.665191429 #> [841] 3.669554752 3.673918075 3.678281399 3.682644722 3.687008045 3.691371368 #> [847] 3.695734691 3.700098014 3.704461337 3.708824660 3.713187984 3.717551307 #> [853] 3.721914630 3.726277953 3.730641276 3.735004599 3.739367922 3.743731246 #> [859] 3.748094569 3.752457892 3.756821215 3.761184538 3.765547861 3.769911184 #> [865] 3.774274507 3.778637831 3.783001154 3.787364477 3.791727800 3.796091123 #> [871] 3.800454446 3.804817769 3.809181092 3.813544416 3.817907739 3.822271062 #> [877] 3.826634385 3.830997708 3.835361031 3.839724354 3.844087678 3.848451001 #> [883] 3.852814324 3.857177647 3.861540970 3.865904293 3.870267616 3.874630939 #> [889] 3.878994263 3.883357586 3.887720909 3.892084232 3.896447555 3.900810878 #> [895] 3.905174201 3.909537524 3.913900848 3.918264171 3.922627494 3.926990817 #> [901] 3.931354140 3.935717463 3.940080786 3.944444110 3.948807433 3.953170756 #> [907] 3.957534079 3.961897402 3.966260725 3.970624048 3.974987371 3.979350695 #> [913] 3.983714018 3.988077341 3.992440664 3.996803987 4.001167310 4.005530633 #> [919] 4.009893956 4.014257280 4.018620603 4.022983926 4.027347249 4.031710572 #> [925] 4.036073895 4.040437218 4.044800541 4.049163865 4.053527188 4.057890511 #> [931] 4.062253834 4.066617157 4.070980480 4.075343803 4.079707127 4.084070450 #> [937] 4.088433773 4.092797096 4.097160419 4.101523742 4.105887065 4.110250388 #> [943] 4.114613712 4.118977035 4.123340358 4.127703681 4.132067004 4.136430327 #> [949] 4.140793650 4.145156973 4.149520297 4.153883620 4.158246943 4.162610266 #> [955] 4.166973589 4.171336912 4.175700235 4.180063559 4.184426882 4.188790205 #> [961] 4.193153528 4.197516851 4.201880174 4.206243497 4.210606820 4.214970144 #> [967] 4.219333467 4.223696790 4.228060113 4.232423436 4.236786759 4.241150082 #> [973] 4.245513405 4.249876729 4.254240052 4.258603375 4.262966698 4.267330021 #> [979] 4.271693344 4.276056667 4.280419991 4.284783314 4.289146637 4.293509960 #> [985] 4.297873283 4.302236606 4.306599929 4.310963252 4.315326576 4.319689899 #> [991] 4.324053222 4.328416545 4.332779868 4.337143191 4.341506514 4.345869837 #> [997] 4.350233161 4.354596484 4.358959807 4.363323130 4.367686453 4.372049776 #> [1003] 4.376413099 4.380776423 4.385139746 4.389503069 4.393866392 4.398229715 #> [1009] 4.402593038 4.406956361 4.411319684 4.415683008 4.420046331 4.424409654 #> [1015] 4.428772977 4.433136300 4.437499623 4.441862946 4.446226269 4.450589593 #> [1021] 4.454952916 4.459316239 4.463679562 4.468042885 4.472406208 4.476769531 #> [1027] 4.481132854 4.485496178 4.489859501 4.494222824 4.498586147 4.502949470 #> [1033] 4.507312793 4.511676116 4.516039440 4.520402763 4.524766086 4.529129409 #> [1039] 4.533492732 4.537856055 4.542219378 4.546582701 4.550946025 4.555309348 #> [1045] 4.559672671 4.564035994 4.568399317 4.572762640 4.577125963 4.581489286 #> [1051] 4.585852610 4.590215933 4.594579256 4.598942579 4.603305902 4.607669225 #> [1057] 4.612032548 4.616395872 4.620759195 4.625122518 4.629485841 4.633849164 #> [1063] 4.638212487 4.642575810 4.646939133 4.651302457 4.655665780 4.660029103 #> [1069] 4.664392426 4.668755749 4.673119072 4.677482395 4.681845718 4.686209042 #> [1075] 4.690572365 4.694935688 4.699299011 4.703662334 4.708025657 4.712388980 #> [1081] 4.716752304 4.721115627 4.725478950 4.729842273 4.734205596 4.738568919 #> [1087] 4.742932242 4.747295565 4.751658889 4.756022212 4.760385535 4.764748858 #> [1093] 4.769112181 4.773475504 4.777838827 4.782202150 4.786565474 4.790928797 #> [1099] 4.795292120 4.799655443 4.804018766 4.808382089 4.812745412 4.817108736 #> [1105] 4.821472059 4.825835382 4.830198705 4.834562028 4.838925351 4.843288674 #> [1111] 4.847651997 4.852015321 4.856378644 4.860741967 4.865105290 4.869468613 #> [1117] 4.873831936 4.878195259 4.882558582 4.886921906 4.891285229 4.895648552 #> [1123] 4.900011875 4.904375198 4.908738521 4.913101844 4.917465167 4.921828491 #> [1129] 4.926191814 4.930555137 4.934918460 4.939281783 4.943645106 4.948008429 #> [1135] 4.952371753 4.956735076 4.961098399 4.965461722 4.969825045 4.974188368 #> [1141] 4.978551691 4.982915014 4.987278338 4.991641661 4.996004984 5.000368307 #> [1147] 5.004731630 5.009094953 5.013458276 5.017821599 5.022184923 5.026548246 #> [1153] 5.030911569 5.035274892 5.039638215 5.044001538 5.048364861 5.052728185 #> [1159] 5.057091508 5.061454831 5.065818154 5.070181477 5.074544800 5.078908123 #> [1165] 5.083271446 5.087634770 5.091998093 5.096361416 5.100724739 5.105088062 #> [1171] 5.109451385 5.113814708 5.118178031 5.122541355 5.126904678 5.131268001 #> [1177] 5.135631324 5.139994647 5.144357970 5.148721293 5.153084617 5.157447940 #> [1183] 5.161811263 5.166174586 5.170537909 5.174901232 5.179264555 5.183627878 #> [1189] 5.187991202 5.192354525 5.196717848 5.201081171 5.205444494 5.209807817 #> [1195] 5.214171140 5.218534463 5.222897787 5.227261110 5.231624433 5.235987756 #> [1201] 5.240351079 5.244714402 5.249077725 5.253441049 5.257804372 5.262167695 #> [1207] 5.266531018 5.270894341 5.275257664 5.279620987 5.283984310 5.288347634 #> [1213] 5.292710957 5.297074280 5.301437603 5.305800926 5.310164249 5.314527572 #> [1219] 5.318890895 5.323254219 5.327617542 5.331980865 5.336344188 5.340707511 #> [1225] 5.345070834 5.349434157 5.353797480 5.358160804 5.362524127 5.366887450 #> [1231] 5.371250773 5.375614096 5.379977419 5.384340742 5.388704066 5.393067389 #> [1237] 5.397430712 5.401794035 5.406157358 5.410520681 5.414884004 5.419247327 #> [1243] 5.423610651 5.427973974 5.432337297 5.436700620 5.441063943 5.445427266 #> [1249] 5.449790589 5.454153912 5.458517236 5.462880559 5.467243882 5.471607205 #> [1255] 5.475970528 5.480333851 5.484697174 5.489060498 5.493423821 5.497787144 #> [1261] 5.502150467 5.506513790 5.510877113 5.515240436 5.519603759 5.523967083 #> [1267] 5.528330406 5.532693729 5.537057052 5.541420375 5.545783698 5.550147021 #> [1273] 5.554510344 5.558873668 5.563236991 5.567600314 5.571963637 5.576326960 #> [1279] 5.580690283 5.585053606 5.589416930 5.593780253 5.598143576 5.602506899 #> [1285] 5.606870222 5.611233545 5.615596868 5.619960191 5.624323515 5.628686838 #> [1291] 5.633050161 5.637413484 5.641776807 5.646140130 5.650503453 5.654866776 #> [1297] 5.659230100 5.663593423 5.667956746 5.672320069 5.676683392 5.681046715 #> [1303] 5.685410038 5.689773362 5.694136685 5.698500008 5.702863331 5.707226654 #> [1309] 5.711589977 5.715953300 5.720316623 5.724679947 5.729043270 5.733406593 #> [1315] 5.737769916 5.742133239 5.746496562 5.750859885 5.755223208 5.759586532 #> [1321] 5.763949855 5.768313178 5.772676501 5.777039824 5.781403147 5.785766470 #> [1327] 5.790129793 5.794493117 5.798856440 5.803219763 5.807583086 5.811946409 #> [1333] 5.816309732 5.820673055 5.825036379 5.829399702 5.833763025 5.838126348 #> [1339] 5.842489671 5.846852994 5.851216317 5.855579640 5.859942964 5.864306287 #> [1345] 5.868669610 5.873032933 5.877396256 5.881759579 5.886122902 5.890486225 #> [1351] 5.894849549 5.899212872 5.903576195 5.907939518 5.912302841 5.916666164 #> [1357] 5.921029487 5.925392811 5.929756134 5.934119457 5.938482780 5.942846103 #> [1363] 5.947209426 5.951572749 5.955936072 5.960299396 5.964662719 5.969026042 #> [1369] 5.973389365 5.977752688 5.982116011 5.986479334 5.990842657 5.995205981 #> [1375] 5.999569304 6.003932627 6.008295950 6.012659273 6.017022596 6.021385919 #> [1381] 6.025749243 6.030112566 6.034475889 6.038839212 6.043202535 6.047565858 #> [1387] 6.051929181 6.056292504 6.060655828 6.065019151 6.069382474 6.073745797 #> [1393] 6.078109120 6.082472443 6.086835766 6.091199089 6.095562413 6.099925736 #> [1399] 6.104289059 6.108652382 6.113015705 6.117379028 6.121742351 6.126105675 #> [1405] 6.130468998 6.134832321 6.139195644 6.143558967 6.147922290 6.152285613 #> [1411] 6.156648936 6.161012260 6.165375583 6.169738906 6.174102229 6.178465552 #> [1417] 6.182828875 6.187192198 6.191555521 6.195918845 6.200282168 6.204645491 #> [1423] 6.209008814 6.213372137 6.217735460 6.222098783 6.226462106 6.230825430 #> [1429] 6.235188753 6.239552076 6.243915399 6.248278722 6.252642045 6.257005368 #> [1435] 6.261368692 6.265732015 6.270095338 6.274458661 6.278821984 6.283185307"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielRings.html","id":null,"dir":"Reference","previous_headings":"","what":"Plot rings on a diel plot — dielRings","title":"Plot rings on a diel plot — dielRings","text":"Plot rings diel plot.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielRings.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plot rings on a diel plot — dielRings","text":"","code":"dielRings( names, starts, ends, cols = \"grey\", format = \"HHMM\", limits = c(1, 2), legend = T )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dielRings.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plot rings on a diel plot — dielRings","text":"names Labels rings starts Start times rings HHMM string format ends End times rings HHMM string format cols Colours rings format Defaults HHMM limits Region dielPlot() plot rings. Defaults c(1,2) legend Boolean. Whether plot legend.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dolbear.html","id":null,"dir":"Reference","previous_headings":"","what":"Dolbear's law — dolbear","title":"Dolbear's law — dolbear","text":"dolbear1897;textualsonicscrewdriver first publish formula rate chirping crickets varies temperature, using tree cricket Oecanthus fultoni.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dolbear.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Dolbear's law — dolbear","text":"","code":"dolbear(n = NULL, t = NULL, species = \"Oecanthus fultoni\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dolbear.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Dolbear's law — dolbear","text":"n Chirps per minute t Temperature Celsius species Species use (default Oecanthus fultoni), NULL calculate species.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dolbear.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Dolbear's law — dolbear","text":"Data frame t n calculated matching species.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dolbear.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Dolbear's law — dolbear","text":"Subsequent research Dolbear others published additional formulae species: Oecanthus fultoni fulton1925sonicscrewdriver, Oecanthus rileyi walker1962sonicscrewdriver, Oecanthus alexanderi walker2010sonicscrewdriver, Oecanthus allardi allard1957sonicscrewdriver.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dolbear.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Dolbear's law — dolbear","text":"","code":"dolbear(n=6) #> species location m c min max source t n #> 1 Oecanthus fultoni Iowa 7.7879 -30.21 15 25 Fulton, 1925 4.649520 6 #> 2 Oecanthus fultoni Oregon 9.2007 -36.53 9 28 Fulton, 1925 4.622474 6 #> 3 Oecanthus fultoni Ohio 8.2080 -38.61 18 31 Walker, 1962 5.434942 6 dolbear(t=25) #> species location m c min max source t n #> 1 Oecanthus fultoni Iowa 7.7879 -30.21 15 25 Fulton, 1925 25 164.4875 #> 2 Oecanthus fultoni Oregon 9.2007 -36.53 9 28 Fulton, 1925 25 193.4875 #> 3 Oecanthus fultoni Ohio 8.2080 -38.61 18 31 Walker, 1962 25 166.5900"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_can_merge.html","id":null,"dir":"Reference","previous_headings":"","what":"Check if two annotations can be merged — .annotation_can_merge","title":"Check if two annotations can be merged — .annotation_can_merge","text":"Check two annotations can merged","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_can_merge.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check if two annotations can be merged — .annotation_can_merge","text":"","code":".annotation_can_merge(annotation1, annotation2, same.source = TRUE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_can_merge.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check if two annotations can be merged — .annotation_can_merge","text":"annotation1 Annotation object. annotation2 Annotation object. .source TRUE, annotations must source merged.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_can_merge.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check if two annotations can be merged — .annotation_can_merge","text":"TRUE annotations can merged, FALSE otherwise.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_check_overlap.html","id":null,"dir":"Reference","previous_headings":"","what":"Check if two annotations overlap or are continuous — .annotation_check_overlap","title":"Check if two annotations overlap or are continuous — .annotation_check_overlap","text":"Check two annotations overlap continuous","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_check_overlap.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check if two annotations overlap or are continuous — .annotation_check_overlap","text":"","code":".annotation_check_overlap(annotation1, annotation2, domain = \"time\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_check_overlap.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check if two annotations overlap or are continuous — .annotation_check_overlap","text":"annotation1 Annotation object. annotation2 Annotation object. domain Domain annotations, either \"time\", \"frequency\", \"\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_check_overlap.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check if two annotations overlap or are continuous — .annotation_check_overlap","text":"TRUE annotations overlap, FALSE otherwise.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-merge_annotations.html","id":null,"dir":"Reference","previous_headings":"","what":"Combine annotations helper function — .merge_annotations","title":"Combine annotations helper function — .merge_annotations","text":"Checks list annotations overlapping time frequency domain, returns list overlapping annotations merged.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-merge_annotations.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Combine annotations helper function — .merge_annotations","text":"","code":".merge_annotations(annotations, domain = \"time\", same.source = TRUE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-merge_annotations.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Combine annotations helper function — .merge_annotations","text":"annotations list Annotation objects. domain Domain annotations, either \"time\" \"frequency\". .source TRUE, annotations must source merged.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-merge_annotations.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Combine annotations helper function — .merge_annotations","text":"list Annotation objects.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-merge_annotations.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Combine annotations helper function — .merge_annotations","text":"exported function merge_annotations() handles sanity checks calls function.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-spectrogram_maad_power.html","id":null,"dir":"Reference","previous_headings":"","what":"Helper function to convert a Wave-like object to scikit-maad spectrogram — .spectrogram_maad_power","title":"Helper function to convert a Wave-like object to scikit-maad spectrogram — .spectrogram_maad_power","text":"Helper function convert Wave-like object scikit-maad spectrogram","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-spectrogram_maad_power.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Helper function to convert a Wave-like object to scikit-maad spectrogram — .spectrogram_maad_power","text":"","code":".spectrogram_maad_power(object)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-spectrogram_maad_power.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Helper function to convert a Wave-like object to scikit-maad spectrogram — .spectrogram_maad_power","text":"object Wave WaveMC object (Tagged equivalent), spectrogram_maad object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-spectrogram_maad_power.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Helper function to convert a Wave-like object to scikit-maad spectrogram — .spectrogram_maad_power","text":"spectrogram_maad object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-spectrum_maad.html","id":null,"dir":"Reference","previous_headings":"","what":"Helper function to convert a Wave-like object to scikit-maad spectrum — .spectrum_maad","title":"Helper function to convert a Wave-like object to scikit-maad spectrum — .spectrum_maad","text":"Helper function convert Wave-like object scikit-maad spectrum","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-spectrum_maad.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Helper function to convert a Wave-like object to scikit-maad spectrum — .spectrum_maad","text":"","code":".spectrum_maad(object)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-spectrum_maad.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Helper function to convert a Wave-like object to scikit-maad spectrum — .spectrum_maad","text":"object Wave WaveMC object (Tagged equivalent), spectrum","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-spectrum_maad.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Helper function to convert a Wave-like object to scikit-maad spectrum — .spectrum_maad","text":"spectrum list","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dutyCycle.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate the duty cycle of a wave — dutyCycle","title":"Calculate the duty cycle of a wave — dutyCycle","text":"Proportion wave signal limit","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dutyCycle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate the duty cycle of a wave — dutyCycle","text":"","code":"dutyCycle(wave, limit = 0.1, output = \"unit\", normalise = TRUE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dutyCycle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate the duty cycle of a wave — dutyCycle","text":"wave Wave object limit Threshold consider signal output \"unit\" duty cycle range 0-1. percentage use \"percent\". normalise TRUE Wave normalised using tuneR","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dutyCycle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Calculate the duty cycle of a wave — dutyCycle","text":"numerical value duty cycle 0 1 (0 100% percentage output).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/dutyCycle.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Calculate the duty cycle of a wave — dutyCycle","text":"","code":"wave <- tuneR::sine(2000) dc <- dutyCycle(wave) pc <- dutyCycle(wave, output=\"percent\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/emptyDiel.html","id":null,"dir":"Reference","previous_headings":"","what":"Create an empty diel plot — emptyDiel","title":"Create an empty diel plot — emptyDiel","text":"Create diel plot labels without sun altitude times day plotted.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/emptyDiel.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create an empty diel plot — emptyDiel","text":"","code":"emptyDiel(method = \"plotrix\", rot = pi)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/emptyDiel.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create an empty diel plot — emptyDiel","text":"method Plotting package use rot Rotation origin (defaults pi)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/emptyYearly.html","id":null,"dir":"Reference","previous_headings":"","what":"Create an empty yearly plot — emptyYearly","title":"Create an empty yearly plot — emptyYearly","text":"Create yearly plot labels without sun night duration plotted.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/emptyYearly.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create an empty yearly plot — emptyYearly","text":"","code":"emptyYearly(year = 2022, method = \"plotix\", rot = pi)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/emptyYearly.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create an empty yearly plot — emptyYearly","text":"year Year plot (allows leap years) method Plotting package use rot Rotation origin (defaults pi)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/entropyStats.html","id":null,"dir":"Reference","previous_headings":"","what":"Various measurements of frequency values for a Wave object — entropyStats","title":"Various measurements of frequency values for a Wave object — entropyStats","text":"Calculates peak, centre, bandwidth quality factor. quality factor (Q) calculated -3dB -10dB discussed Bennett-Clark (1999) doi:10.1080/09524622.1999.9753408.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/entropyStats.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Various measurements of frequency values for a Wave object — entropyStats","text":"","code":"entropyStats(wave)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/entropyStats.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Various measurements of frequency values for a Wave object — entropyStats","text":"wave Wave object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/entropyStats.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Various measurements of frequency values for a Wave object — entropyStats","text":"list spectral entropy types.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/entropyStats.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Various measurements of frequency values for a Wave object — entropyStats","text":"","code":"if (FALSE) { # \\dontrun{ entropyStats(sheep) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/filterWave.html","id":null,"dir":"Reference","previous_headings":"","what":"Apply a WaveFilter object to a Wave object — filterWave","title":"Apply a WaveFilter object to a Wave object — filterWave","text":"WaveFilter object object containing information necessary filterw function apply filter Wave object. designed allow pipe operator (either magrittr base R) used apply filters Wave pipeline.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/filterWave.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Apply a WaveFilter object to a Wave object — filterWave","text":"","code":"filterWave(w, filt, cl = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/filterWave.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Apply a WaveFilter object to a Wave object — filterWave","text":"w Wave object. filt Wave object selected filter applied. cl Optional. cluster specified, filter applied parallel.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/filterWave.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Apply a WaveFilter object to a Wave object — filterWave","text":"Supported filters include seewave package.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/frequencySound.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the frequency from wavelength and speed of sound — frequencySound","title":"Get the frequency from wavelength and speed of sound — frequencySound","text":"Calculates frequency sound wave given wavelength speed sound medium.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/frequencySound.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the frequency from wavelength and speed of sound — frequencySound","text":"","code":"frequencySound(wl, s = soundSpeed(medium = \"air\"))"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/frequencySound.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the frequency from wavelength and speed of sound — frequencySound","text":"wl Wavelength s Speed sound (defaults speed sound air)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/frequencySound.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the frequency from wavelength and speed of sound — frequencySound","text":"Frequency sound Hertz","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/frequencySound.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get the frequency from wavelength and speed of sound — frequencySound","text":"","code":"f <- frequencySound(wl=100, s=343)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/frequencyStats.html","id":null,"dir":"Reference","previous_headings":"","what":"Various measurements of frequency values for a Wave object — frequencyStats","title":"Various measurements of frequency values for a Wave object — frequencyStats","text":"Calculates peak, centre, bandwidth quality factor. quality factor (Q) calculated -3dB -10dB discussed Bennett-Clark (1999) .","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/frequencyStats.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Various measurements of frequency values for a Wave object — frequencyStats","text":"","code":"frequencyStats(wave, wave_spec = NULL, warn = TRUE, lowcut = 1, plot = FALSE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/frequencyStats.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Various measurements of frequency values for a Wave object — frequencyStats","text":"wave Wave object wave_spec precomputed spectrum (optional, present generated) warn TRUE provides warnings values consistent lowcut Frequency (kHz) values ignored. plot TRUE displays values","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateNoise.html","id":null,"dir":"Reference","previous_headings":"","what":"Add noise to a Wave like object — generateNoise","title":"Add noise to a Wave like object — generateNoise","text":"Adding noise Wave like object allows testing robustness automated identification algorithms noise.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateNoise.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add noise to a Wave like object — generateNoise","text":"","code":"generateNoise( wave, noise = c(\"white\"), noise.add = FALSE, noise.ratio = 0.5, noise.ref = \"file\", output = \"list\" )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateNoise.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add noise to a Wave like object — generateNoise","text":"wave Object add noise (Wave, WaveMC, Tagged versions), list objects. noise Vector noise add (unif, gaussian, white, pink, power, red) noise.add TRUE noise sources added wave. FALSE separate outputs created noise source. noise.ratio Ratio maximum noise amplitude maximum amplitude wave. noise.ref Reference maximum noise.ratio. \"max\" maximum amplitude, \"file\" maximum amplitude wave. output TODO: implemented?","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateNoise.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add noise to a Wave like object — generateNoise","text":"list Wave objects required noise added.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateTimeMask.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate time masked Wave-like objects — generateTimeMask","title":"Generate time masked Wave-like objects — generateTimeMask","text":"Given Wave-like object (list Wave-like objects), generate new Wave-like objects time masking.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateTimeMask.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate time masked Wave-like objects — generateTimeMask","text":"","code":"generateTimeMask(wave, method = \"squarewave\", dutyCycle = 0.95, n.periods = 10)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateTimeMask.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate time masked Wave-like objects — generateTimeMask","text":"wave Wave-like object (list Wave-like objects). method method use time masking (one \"squarewave\", \"random). dutyCycle duty cycle output. value 0.95 means 5% time masked. n.periods number waves generate squarewave method.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateTimeShift.html","id":null,"dir":"Reference","previous_headings":"","what":"Generated time-shifted versions of a Wave-like object — generateTimeShift","title":"Generated time-shifted versions of a Wave-like object — generateTimeShift","text":"Given Wave-like object (list Wave-like objects), function generates time-shifted versions object. time-shifted versions generated adding constant amount time start end object. achieved either inserting silence truncating object original length, rotating audio within object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateTimeShift.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generated time-shifted versions of a Wave-like object — generateTimeShift","text":"","code":"generateTimeShift( wave, type = \"silent\", amount = c(1, 2), where = \"start\", output = \"list\" )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateTimeShift.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generated time-shifted versions of a Wave-like object — generateTimeShift","text":"wave Wave-like object list Wave-like objects. type type time-shift apply. Either \"silent\" \"rotate\". amount Vector amount time shift (seconds). insert silence type \"silent\". output Return list.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/generateTimeShift.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generated time-shifted versions of a Wave-like object — generateTimeShift","text":"Wave-like object list Wave-like objects.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/getMaad.html","id":null,"dir":"Reference","previous_headings":"","what":"Import scikit-maad — getMaad","title":"Import scikit-maad — getMaad","text":"Imports scikit-maad object R. allows reuse object function calls.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/getMaad.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Import scikit-maad — getMaad","text":"","code":"getMaad()"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/gs_transcribe.html","id":null,"dir":"Reference","previous_headings":"","what":"Google Speech API Transcribe — gs_transcribe","title":"Google Speech API Transcribe — gs_transcribe","text":"Wrapper around various Google packages simplify speech transcription.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/gs_transcribe.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Google Speech API Transcribe — gs_transcribe","text":"","code":"gs_transcribe(filename, bucket = NULL, ...)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/gs_transcribe.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Google Speech API Transcribe — gs_transcribe","text":"filename Path file analysis bucket Storage bucket Google Cloud larger files ... Additional arguments pass gl_speech()","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/gs_transcribe.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Google Speech API Transcribe — gs_transcribe","text":"gs_transcribe object containing details transcription","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/gs_transcribe.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Google Speech API Transcribe — gs_transcribe","text":"","code":"if (FALSE) { # \\dontrun{ gs_transcribe(\"demo.wav\") } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/humanBytes.html","id":null,"dir":"Reference","previous_headings":"","what":"Converts bytes in human readable form — humanBytes","title":"Converts bytes in human readable form — humanBytes","text":"Given input bytes calculates result sensible output unit (e.g. MB, GB, PB).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/humanBytes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Converts bytes in human readable form — humanBytes","text":"","code":"humanBytes(S)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/humanBytes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Converts bytes in human readable form — humanBytes","text":"S Number bytes","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/humanBytes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Converts bytes in human readable form — humanBytes","text":"String human readable format","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/humanTime.html","id":null,"dir":"Reference","previous_headings":"","what":"Converts time to human readable form — humanTime","title":"Converts time to human readable form — humanTime","text":"Given input bytes calculates result sensible output unit (e.g. minutes, hours).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/humanTime.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Converts time to human readable form — humanTime","text":"","code":"humanTime(S, unit = \"seconds\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/humanTime.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Converts time to human readable form — humanTime","text":"S Time convert unit unit unit time convert","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/humanTime.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Converts time to human readable form — humanTime","text":"String human readable format","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/jitter.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate the jitter in a Wave object — jitter","title":"Calculate the jitter in a Wave object — jitter","text":"Jitter measure variability periods waveform. Relative jitter scaled jitter analysed waveform.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/jitter.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate the jitter in a Wave object — jitter","text":"","code":"jitter(wave, method = \"absolute\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/jitter.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate the jitter in a Wave object — jitter","text":"wave Wave object method One \"absolute\" \"relative\"","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/jitter.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Calculate the jitter in a Wave object — jitter","text":"vector zero crossing locations","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/jitter.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Calculate the jitter in a Wave object — jitter","text":"","code":"if (FALSE) { # \\dontrun{ jitter(sheep, method=\"absolute\") jitter(sheep, method=\"relative\") } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelPadding.html","id":null,"dir":"Reference","previous_headings":"","what":"Pad labels with interval — labelPadding","title":"Pad labels with interval — labelPadding","text":"Takes labels Google Speech API transcript pads time specified number seconds.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelPadding.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pad labels with interval — labelPadding","text":"","code":"labelPadding(t, pad = 0.5, max_t = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelPadding.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pad labels with interval — labelPadding","text":"t Transcript Google Speech API pad Amount time (seconds) add start end max_t Optional. duration file, padding exceed length file.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelPadding.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pad labels with interval — labelPadding","text":"modified Google Speech API transcript object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelPadding.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Pad labels with interval — labelPadding","text":"","code":"if (FALSE) { # \\dontrun{ labelPadding(t, pad=2, max_t=duration(wave)) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelReduction.html","id":null,"dir":"Reference","previous_headings":"","what":"Combines labels which overlap into single continuous regions — labelReduction","title":"Combines labels which overlap into single continuous regions — labelReduction","text":"Takes labels Google Speech API transcript combines overlapping labels.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelReduction.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Combines labels which overlap into single continuous regions — labelReduction","text":"","code":"labelReduction(t)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelReduction.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Combines labels which overlap into single continuous regions — labelReduction","text":"t Transcript Google Speech API","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelReduction.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Combines labels which overlap into single continuous regions — labelReduction","text":"list containing start end times speech containing regions","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/labelReduction.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Combines labels which overlap into single continuous regions — labelReduction","text":"","code":"if (FALSE) { # \\dontrun{ labelReduction(t) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_acoustic_complexity_index.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute the acoustic complexity index using scikit-maad — maad_acoustic_complexity_index","title":"Compute the acoustic complexity index using scikit-maad — maad_acoustic_complexity_index","text":"ACI depends duration spectrogram derivation signal normalized sum signal. Thus, background noise high due high acoustic activity normalization sum signal reduced ACI. ACI low acoustic activity high acoustic activity continuous background noise. ACI high acoustic activity medium, sounds well background noise.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_acoustic_complexity_index.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute the acoustic complexity index using scikit-maad — maad_acoustic_complexity_index","text":"","code":"maad_acoustic_complexity_index(object, maad = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_acoustic_complexity_index.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute the acoustic complexity index using scikit-maad — maad_acoustic_complexity_index","text":"object Wave object spectrogram_maad object generated maad_spectrogram. Wave-like object provided, spectrogram calculated using default parameters. maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_acoustic_complexity_index.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute the acoustic complexity index using scikit-maad — maad_acoustic_complexity_index","text":"List comprising: ACI_xx Acoustic Complexity Index. ACI_per_bin Acoustic Complexity Index. ACI_sum Sum ACI value per frequency bin (Common definition)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_acoustic_complexity_index.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Compute the acoustic complexity index using scikit-maad — maad_acoustic_complexity_index","text":"addition documentation see https://scikit-maad.github.io/generated/maad.features.temporal_acoustic_complexity_index.html pieretti2011sonicscrewdriver.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_frequency_entropy.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute the frequency entropy using scikit-maad — maad_frequency_entropy","title":"Compute the frequency entropy using scikit-maad — maad_frequency_entropy","text":"spectral entropy signal measures energy dispersion along frequencies. Low values indicates concentration energy around narrow frequency band. DC value removed processing large peak f=0Hz lower entropy signal.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_frequency_entropy.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute the frequency entropy using scikit-maad — maad_frequency_entropy","text":"","code":"maad_frequency_entropy(object, compatibility = \"QUT\", maad = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_frequency_entropy.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute the frequency entropy using scikit-maad — maad_frequency_entropy","text":"object Wave object spectrogram_maad object generated maad_spectrogram. Wave-like object provided, spectrogram calculated using default parameters. compatibility One \"QUT\" qutsonicscrewdriver \"seewave\" seewave2008sonicscrewdriver. Default \"QUT\". maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_frequency_entropy.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute the frequency entropy using scikit-maad — maad_frequency_entropy","text":"List comprising: Hf Frequency entropy. Ht_per_bin Temporal entropy per frequency bin.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_frequency_entropy.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Compute the frequency entropy using scikit-maad — maad_frequency_entropy","text":"addition documentation see https://scikit-maad.github.io/generated/maad.features.frequency_entropy.html","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_number_of_peaks.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute the number of peaks using scikit-maad — maad_number_of_peaks","title":"Compute the number of peaks using scikit-maad — maad_number_of_peaks","text":"Count number frequency peaks mean spectrum. function adapted function fpeaks R package Seewave seewave2008sonicscrewdriver.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_number_of_peaks.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute the number of peaks using scikit-maad — maad_number_of_peaks","text":"","code":"maad_number_of_peaks( object, mode = \"dB\", min_peak_val = NULL, min_freq_dist = 200, slopes = c(1, 1), prominence = 0, maad = NULL )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_number_of_peaks.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute the number of peaks using scikit-maad — maad_number_of_peaks","text":"object Wave object spectrogram_maad object generated maad_spectrogram. Wave-like object provided, spectrogram calculated using default parameters. mode One \"dB\", \"linear\". min_peak_val peaks threshold considered. min_freq_dist Frequency threshold parameter (Hz). frequency difference two successive peaks less threshold, peak highest amplitude kept . slopes Refers amplitude slopes peak. first value left slope second value right slope. peaks higher slopes threshold values kept. prominence first element minimal prominence second element maximal prominence. single number provided interpreted minimal value, maximal value used. maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_number_of_peaks.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute the number of peaks using scikit-maad — maad_number_of_peaks","text":"Numeric number peaks","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_number_of_peaks.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Compute the number of peaks using scikit-maad — maad_number_of_peaks","text":"addition documentation see https://scikit-maad.github.io/generated/maad.features.number_of_peaks.html","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectral_activity.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute the spectral activity using scikit-maad — maad_spectral_activity","title":"Compute the spectral activity using scikit-maad — maad_spectral_activity","text":"Acoustic activity corresponds portion spectrogram threshold frequency per frequency along time axis towsey2017sonicscrewdriver.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectral_activity.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute the spectral activity using scikit-maad — maad_spectral_activity","text":"","code":"maad_spectral_activity(object, dB_threshold = 6, maad = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectral_activity.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute the spectral activity using scikit-maad — maad_spectral_activity","text":"object Wave object spectrogram_maad object. dB_threshold dB threshold activity (default = 6). maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectral_activity.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute the spectral activity using scikit-maad — maad_spectral_activity","text":"function computes frequency bin: ACTfract Proportion (fraction) points threshold. ACTcount Total number points threshold. ACTmean Mean value (dB) portion signal threshold.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectral_entropy.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute the frequency entropy using scikit-maad — maad_spectral_entropy","title":"Compute the frequency entropy using scikit-maad — maad_spectral_entropy","text":"Compute different entropies based average spectrum, variance, maxima.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectral_entropy.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute the frequency entropy using scikit-maad — maad_spectral_entropy","text":"","code":"maad_spectral_entropy(object, flim = NULL, maad = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectral_entropy.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute the frequency entropy using scikit-maad — maad_spectral_entropy","text":"object Wave object spectrogram_maad object generated maad_spectrogram. Wave-like object provided, spectrogram calculated using default parameters. flim numeric vector length 2 specifying frequency limits entropy calculation. maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectral_entropy.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute the frequency entropy using scikit-maad — maad_spectral_entropy","text":"List comprising: EAS Entropy Average Spectrum. ECU Entropy spectral variance (along time axis frequency). ECV Entropy Coefficient Variation (along time axis frequency). EPS Entropy spectral maxima (peaks). EPS_KURT Kurtosis spectral maxima. EPS_SKEW Skewness spectral maxima.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectral_entropy.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Compute the frequency entropy using scikit-maad — maad_spectral_entropy","text":"addition documentation see https://scikit-maad.github.io/generated/maad.features.spectral_entropy.html","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectrogram.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute a spectrogram of a sound wave using scikit-maad — maad_spectrogram","title":"Compute a spectrogram of a sound wave using scikit-maad — maad_spectrogram","text":"wrapper function maad.sound.spectrogram function scikit-maad package Python. computes spectrogram sound wave. usage details provided https://maad.readthedocs.io/en/latest/maad.sound.html#maad.sound.spectrogram.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectrogram.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute a spectrogram of a sound wave using scikit-maad — maad_spectrogram","text":"","code":"maad_spectrogram(wave, mode = \"power\", ..., maad = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectrogram.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute a spectrogram of a sound wave using scikit-maad — maad_spectrogram","text":"wave Wave object mode type spectrogram compute. Options \"power\", \"amplitude\" \"complex\". Default \"power\". ... Additional arguments pass maad.sound.spectrogram. maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectrogram.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute a spectrogram of a sound wave using scikit-maad — maad_spectrogram","text":"Generically spectrogram_maad object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectrum.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute a spectrum of a sound wave using scikit-maad — maad_spectrum","title":"Compute a spectrum of a sound wave using scikit-maad — maad_spectrum","text":"wrapper function maad.sound.spectrum function. computes spectrum sound wave. usage details provided https://maad.readthedocs.io/en/latest/maad.sound.html#maad.sound.spectrum.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectrum.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute a spectrum of a sound wave using scikit-maad — maad_spectrum","text":"","code":"maad_spectrum(wave, ..., maad = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectrum.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute a spectrum of a sound wave using scikit-maad — maad_spectrum","text":"wave Wave object ... Additional arguments pass maad.sound.spectrum. maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_spectrum.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute a spectrum of a sound wave using scikit-maad — maad_spectrum","text":"list comprising: pxx Power spectral density estimate. f_idx Index sample frequencies.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_activity.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute the acoustic activity index using scikit-maad — maad_temporal_activity","title":"Compute the acoustic activity index using scikit-maad — maad_temporal_activity","text":"addition documentation see https://scikit-maad.github.io/generated/maad.features.temporal_activity.html towsey2013sonicscrewdriver.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_activity.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute the acoustic activity index using scikit-maad — maad_temporal_activity","text":"","code":"maad_temporal_activity( wave, dB_threshold = 3, mode = \"fast\", Nt = 512, maad = NULL )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_activity.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute the acoustic activity index using scikit-maad — maad_temporal_activity","text":"wave Wave object. dB_threshold dB threshold activity (default = 3). mode Mode envelope calculation. Can \"fast\" \"Hilbert\". Nt Size frame. largest, highest approximation. maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_activity.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute the acoustic activity index using scikit-maad — maad_temporal_activity","text":"List calculated values, comprising: ACTfrac fraction)points threshold frequency bin. ACTcount total number points threshold frequency bin. ACTmean mean value (dB) portion signal threshold.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_entropy.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute the temporal entropy using scikit-maad — maad_temporal_entropy","title":"Compute the temporal entropy using scikit-maad — maad_temporal_entropy","text":"addition documentation see https://scikit-maad.github.io/generated/maad.features.temporal_entropy.html.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_entropy.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute the temporal entropy using scikit-maad — maad_temporal_entropy","text":"","code":"maad_temporal_entropy( wave, compatibility = \"QUT\", mode = \"fast\", Nt = 512, maad = NULL )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_entropy.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute the temporal entropy using scikit-maad — maad_temporal_entropy","text":"wave Wave object. compatibility One \"QUT\" qutsonicscrewdriver, \"seewave\" seewave2008sonicscrewdriver. mode Mode envelope calculation. Can \"fast\" \"hilbert\". Nt Size frame. largest, highest approximation. maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_entropy.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute the temporal entropy using scikit-maad — maad_temporal_entropy","text":"Numeric entropy envelope.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_events.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute the acoustic event index using scikit-maad — maad_temporal_events","title":"Compute the acoustic event index using scikit-maad — maad_temporal_events","text":"acoustic event corresponds period signal threshold. acoustic event short (list one point rejectDuration None) long (duration entire audio). Two acoustic events separated period low audio signal (.e. threshold).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_events.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute the acoustic event index using scikit-maad — maad_temporal_events","text":"","code":"maad_temporal_events( wave, dB_threshold = 3, rejectDuration = 0.1, mode = \"fast\", Nt = 512, maad = NULL )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_events.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute the acoustic event index using scikit-maad — maad_temporal_events","text":"wave Wave object. dB_threshold dB threshold activity (default = 3). rejectDuration Duration silence reject acoustic event (default = 0.1). mode Mode envelope calculation. Can \"fast\" \"Hilbert\". Nt Size frame. larger, highest approximation. maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_events.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute the acoustic event index using scikit-maad — maad_temporal_events","text":"List calculated values, comprising: EVTfrac fraction points threshold frequency bin. EVTcount total number points threshold frequency bin. EVTmean mean value (dB) portion signal threshold. EVN logical vector matrix 1 corresponding event position.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_events.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Compute the acoustic event index using scikit-maad — maad_temporal_events","text":"addition documentation see https://scikit-maad.github.io/generated/maad.features.temporal_events.html towsey2013sonicscrewdriver qutsonicscrewdriver.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_median.html","id":null,"dir":"Reference","previous_headings":"","what":"Compute the temporal envelope median using scikit-maad — maad_temporal_median","title":"Compute the temporal envelope median using scikit-maad — maad_temporal_median","text":"addition documentation see https://scikit-maad.github.io/generated/maad.features.temporal_median.html.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_median.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Compute the temporal envelope median using scikit-maad — maad_temporal_median","text":"","code":"maad_temporal_median(wave, mode = \"fast\", Nt = 512, maad = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_median.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Compute the temporal envelope median using scikit-maad — maad_temporal_median","text":"wave Wave object. mode Mode envelope calculation. Can \"fast\" \"hilbert\". Nt Size frame. largest, highest approximation. maad optional maad object. provided, one created using getMaad().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_median.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Compute the temporal envelope median using scikit-maad — maad_temporal_median","text":"Numeric median envelope.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/map2RGB.html","id":null,"dir":"Reference","previous_headings":"","what":"Map three vectors to RGB — map2RGB","title":"Map three vectors to RGB — map2RGB","text":"Maps three vectors equal length RGB use false-colour index spectrograms","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/map2RGB.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Map three vectors to RGB — map2RGB","text":"","code":"map2RGB(red, green, blue)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/map2RGB.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Map three vectors to RGB — map2RGB","text":"red red channel vector green green channel vector blue blue channel vector","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/map2RGB.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Map three vectors to RGB — map2RGB","text":"vector RGB values","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/merge_annotations.html","id":null,"dir":"Reference","previous_headings":"","what":"Combine annotations — merge_annotations","title":"Combine annotations — merge_annotations","text":"Checks list annotations overlapping time frequency domain, returns list overlapping annotations merged. Annotation objects must file, type value merged.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/merge_annotations.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Combine annotations — merge_annotations","text":"","code":"merge_annotations(annotations, domain = \"time\", same.source = TRUE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/merge_annotations.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Combine annotations — merge_annotations","text":"annotations list Annotation objects. domain Domain annotations, either \"time\" \"frequency\". .source TRUE, annotations must source merged.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/merge_annotations.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Combine annotations — merge_annotations","text":"list Annotation objects.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/naturalFrequency.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate the natural frequency — naturalFrequency","title":"Calculate the natural frequency — naturalFrequency","text":"Calculates natural frequency given inductance, capacitance resistance. acoustic case inductance inertia mass, capacitance elasticity (bulk modulus) resistance composed air resistance related quantities. units SI.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/naturalFrequency.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate the natural frequency — naturalFrequency","text":"","code":"naturalFrequency(L, C = \"default\", R)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/naturalFrequency.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate the natural frequency — naturalFrequency","text":"L Inductance C Capacitance, default IUPAC standard pressure. R Resistance","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/naturalFrequency.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Calculate the natural frequency — naturalFrequency","text":"isothermal compression, bulk modulus equal pressure. default value C therefore IUPAC standard pressure.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/naturalFrequency.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Calculate the natural frequency — naturalFrequency","text":"","code":"naturalFrequency(L=20,R=0.5) #> [1] 0.002950812 naturalFrequency(L=20,C=1/4,R=0.5) #> [1] 0.07114845"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/normalise.html","id":null,"dir":"Reference","previous_headings":"","what":"Normalise a Wave object — normalise","title":"Normalise a Wave object — normalise","text":"Similar normalize() tuneR package automatically identifies unit parameter.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/normalise.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Normalise a Wave object — normalise","text":"","code":"normalise(wave, unit = NULL, ...)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/normalise.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Normalise a Wave object — normalise","text":"wave Wave WaveMC object unit null behaves normalize() tuneR, null unit automatically identified. ... Additional arguments passed normalize() tuneR","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/normalise.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Normalise a Wave object — normalise","text":"Normalised Wave WaveMC object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ntd.html","id":null,"dir":"Reference","previous_headings":"","what":"Natural Time Domain — ntd","title":"Natural Time Domain — ntd","text":"Runs function wave outputs values Natural Time Domain (see Varotsos, Sarlis & Skordas(2011) doi:10.1007/978-3-642-16449-1).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ntd.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Natural Time Domain — ntd","text":"","code":"ntd(wave, events, FUN, normalise = FALSE, argument = \"wave\", ...)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ntd.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Natural Time Domain — ntd","text":"wave Wave object containing pulses events Onset detected events, e.g. pulseDetection() FUN function run normalise TRUE output probability density argument \"wave\" supplies weave object function, \"vector\" supplies left channel numeric vector. ... Additional arguments FUN","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ntd.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Natural Time Domain — ntd","text":"list outputs form applied function","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/parseFilename.html","id":null,"dir":"Reference","previous_headings":"","what":"Parse a filename — parseFilename","title":"Parse a filename — parseFilename","text":"Attempts extract meaningful information filename, typically date time recording started.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/parseFilename.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Parse a filename — parseFilename","text":"","code":"parseFilename(file, format = NULL, timezone = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/parseFilename.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Parse a filename — parseFilename","text":"file filename (list filenames). format Optionally force given format (see Details). NULL (default) attempt made automatically detect format file. \"match\" list filenames given attempt made find format matches files. may give incorrect results filename ambiguous (see Details). timezone Optionally set timezone.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/parseFilename.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Parse a filename — parseFilename","text":"list file, type match, datetime. possible determine additional properties files, added list.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/parseFilename.html","id":"determining-the-format","dir":"Reference","previous_headings":"","what":"Determining the format","title":"Parse a filename — parseFilename","text":"sometimes impossible accurately determine format filename, e.g. eight-digit 'AudioMoth HEX' contains numbers confused YYYYMMDD format. list filenames given \"match\" format specified effort made determine likely format applies filenames.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/parseFilename.html","id":"supported-formats","dir":"Reference","previous_headings":"","what":"Supported formats","title":"Parse a filename — parseFilename","text":"AudioMoth - newer format AudioMoth devices consists standard YYYYMMDD_HHMMSS.wav format. Specifying 'AudioMoth' forces call audiomoth() function seewave package seewave2008sonicscrewdriver. AudioMoth HEX - Older format AudioMoth devices consisting eight hexadecimal characters. Conversion handled call seewave::audiomoth(). timestamp - standard date-time format. Uses R standard origin 1970-01-01 00:00:00 UTC. Wildlife Acoustics SM2 - Can also used Wildlife Acoustics SM4 devices. Conversion handled call seewave::songmeter(). Wildlife Acoustics SM3 - Conversion handled call seewave::songmeter(). YYYYMMDD_HHMMSS - standard date-time format.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/parseFilename.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Parse a filename — parseFilename","text":"","code":"parseFilename(\"5E90A4D4.wav\") #> $filename #> [1] \"5E90A4D4.wav\" #> #> $match #> [1] \"AudioMoth HEX\" #> #> $datetime #> [1] \"2020-04-10 16:54:44 UTC\" #>"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pd_dietrich2004.html","id":null,"dir":"Reference","previous_headings":"","what":"Pulse detection using Dietrich (2004) — pd_dietrich2004","title":"Pulse detection using Dietrich (2004) — pd_dietrich2004","text":"Detects pulses Wave using method described Dietrich et al (2004) doi:10.1016/j.patcog.2004.04.004.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pd_dietrich2004.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pulse detection using Dietrich (2004) — pd_dietrich2004","text":"","code":"pd_dietrich2004( wave, U = 120, gamma = 0.05, alpha = 1.4, scaling = 32, V = 480, psi = 1 )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pd_dietrich2004.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pulse detection using Dietrich (2004) — pd_dietrich2004","text":"wave Wave object U Window length gamma Gamma alpha Alpha scaling Scaling V V Window length psi Psi","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pd_dietrich2004.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pulse detection using Dietrich (2004) — pd_dietrich2004","text":"list input values plus onset offset times pulses","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pd_simple.html","id":null,"dir":"Reference","previous_headings":"","what":"Simplified pulse detection using Dietrich (2004) — pd_simple","title":"Simplified pulse detection using Dietrich (2004) — pd_simple","text":"Detects pulses Wave.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pd_simple.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Simplified pulse detection using Dietrich (2004) — pd_simple","text":"","code":"pd_simple( wave, U = 120, gamma = 0.05, alpha = 1.4, scaling = 32, V = 480, psi = 1 )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pd_simple.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Simplified pulse detection using Dietrich (2004) — pd_simple","text":"wave Wave object U Window length gamma Gamma alpha Alpha scaling Scaling V V Window length psi Psi","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/plus-PseudoWave-numeric-method.html","id":null,"dir":"Reference","previous_headings":"","what":"PseudoWave scalar addition — +,PseudoWave,numeric-method","title":"PseudoWave scalar addition — +,PseudoWave,numeric-method","text":"PseudoWave scalar addition","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/plus-PseudoWave-numeric-method.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"PseudoWave scalar addition — +,PseudoWave,numeric-method","text":"","code":"# S4 method for class 'PseudoWave,numeric' e1 + e2"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/plus-PseudoWave-numeric-method.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"PseudoWave scalar addition — +,PseudoWave,numeric-method","text":"e1 Input 1 e2 Input 2","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/plus-numeric-PseudoWave-method.html","id":null,"dir":"Reference","previous_headings":"","what":"Numeric addition by PseudoWave — +,numeric,PseudoWave-method","title":"Numeric addition by PseudoWave — +,numeric,PseudoWave-method","text":"Numeric addition PseudoWave","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/plus-numeric-PseudoWave-method.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Numeric addition by PseudoWave — +,numeric,PseudoWave-method","text":"","code":"# S4 method for class 'numeric,PseudoWave' e1 + e2"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/plus-numeric-PseudoWave-method.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Numeric addition by PseudoWave — +,numeric,PseudoWave-method","text":"e1 Input 1 e2 Input 2","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pseudoWave.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a PseudoWave object — pseudoWave","title":"Create a PseudoWave object — pseudoWave","text":"function used create PseudoWave object can used generate Wave object operated .","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pseudoWave.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a PseudoWave object — pseudoWave","text":"","code":"pseudoWave( type = NA_character_, subtype = NA_character_, scale = 1, offset = 0, seed = 1, params = list() )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pseudoWave.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a PseudoWave object — pseudoWave","text":"type Type PseudoWave (e.g. \"noise\", \"sine\") subtype Subtype PseudoWave (e.g. \"white\" type \"noise\") scale Wave channels multiplied value offset value added Wave channels seed Random seed reproducible output. NA params List additional parameters pass generating function","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pseudoWave.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a PseudoWave object — pseudoWave","text":"PseudoWave object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pseudoWave.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a PseudoWave object — pseudoWave","text":"","code":"pw <- pseudoWave(\"noise\", \"white\") pw <- pseudoWave(\"sine\", params=list(\"f0\"=440))"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulse.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a single pulse — pulse","title":"Generate a single pulse — pulse","text":"Generate single pulse, either Dirac pulse (Dirac delta) square pulse.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulse.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a single pulse — pulse","text":"","code":"pulse( type = \"dirac\", leading = 22050, pulse.length = 1, duration = samp.rate, samp.rate = 44100, bit = 1, pcm = FALSE, stereo = FALSE, output = \"Wave\", invert = FALSE )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulse.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a single pulse — pulse","text":"type Either \"dirac\" \"square\". leading number samples pulse. pulse.length number samples pulse (\"square\"). duration total number samples generated. samp.rate sample rate. bit bit depth. pcm Whether Wave generated PCM (see tuneR). stereo Whether Wave generated stereo. output output format (\"Wave\"). invert Whether invert pulse.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulse.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a single pulse — pulse","text":"Specified output.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulseDetection.html","id":null,"dir":"Reference","previous_headings":"","what":"Pulse detection — pulseDetection","title":"Pulse detection — pulseDetection","text":"Detects pulses Wave, defaults using Dietrich (2004).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulseDetection.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pulse detection — pulseDetection","text":"","code":"pulseDetection(wave, method = \"simple\", ...)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulseDetection.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pulse detection — pulseDetection","text":"wave Wave object containing pulses method method use pulse detection ... arguments pass pulse detection function","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulseIntervals.html","id":null,"dir":"Reference","previous_headings":"","what":"Pulse intervals — pulseIntervals","title":"Pulse intervals — pulseIntervals","text":"Used locate area pulses results pulseDetection().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulseIntervals.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pulse intervals — pulseIntervals","text":"","code":"pulseIntervals(pulses, nsd = 2)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulseIntervals.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Pulse intervals — pulseIntervals","text":"pulses result pulseDetection. nsd number standard deviations sid mean pulse interval discard","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pulseIntervals.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Pulse intervals — pulseIntervals","text":"list onset offset times pulses","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pythonInstall.html","id":null,"dir":"Reference","previous_headings":"","what":"Install sonicscrewdriver Python environment — pythonInstall","title":"Install sonicscrewdriver Python environment — pythonInstall","text":"function installs scikit-maad sonicscrewdriver environment using reticulate.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pythonInstall.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install sonicscrewdriver Python environment — pythonInstall","text":"","code":"pythonInstall(unattended = FALSE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pythonInstall.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install sonicscrewdriver Python environment — pythonInstall","text":"unattended TRUE function prompt user install environment non-interactive session.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/pythonInstall.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install sonicscrewdriver Python environment — pythonInstall","text":"","code":"if (FALSE) { # \\dontrun{ maadInstall() maadInstall(unattended=TRUE) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarPower.html","id":null,"dir":"Reference","previous_headings":"","what":"The radar equation — radarPower","title":"The radar equation — radarPower","text":"Calculates power returned echolocation pulse","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarPower.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The radar equation — radarPower","text":"","code":"radarPower(P_t, r, area, G_t = 1, G_r = 1, wl = 1)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarPower.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"The radar equation — radarPower","text":"P_t Power transmitted (sender) r Range target area Effective cross-sectional area target G_t Transmitter gain G_r Receiver gain wl Wavelength (use G_r G_t)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarPower.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"The radar equation — radarPower","text":"received power","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarPower.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"The radar equation — radarPower","text":"","code":"radarPower(12, 20, 0.05) #> [1] 1.889738e-09 radarPower(12, 20, 0.05, G_t=1.2, G_r=1.5, wl=0.045) #> [1] 6.888096e-12"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarRange.html","id":null,"dir":"Reference","previous_headings":"","what":"Radar range — radarRange","title":"Radar range — radarRange","text":"Calculates distance object based round trip time echolocation pulse","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarRange.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Radar range — radarRange","text":"","code":"radarRange(t, c = soundSpeed(medium = \"air\"))"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarRange.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Radar range — radarRange","text":"t Time seconds c Speed sound transmission medium m/s (default air)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarRange.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Radar range — radarRange","text":"Distance object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radarRange.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Radar range — radarRange","text":"","code":"radarRange(2) #> [1] 343 radarRange(2, c=343) #> [1] 343 radarRange(2, c=soundSpeed(medium = \"sea water\")) #> [1] 1500"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radialPolygon.html","id":null,"dir":"Reference","previous_headings":"","what":"Plot a radial polygon — radialPolygon","title":"Plot a radial polygon — radialPolygon","text":"Used plot sectors, annuli horizons dielPlot() yearlyPlot(). polygon inner outer horizon - can set fixed radius vector.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radialPolygon.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Plot a radial polygon — radialPolygon","text":"","code":"radialPolygon( angle1, angle2, radius1, radius2, col = \"grey\", border = NA, rot = -pi, angleinc = 0.01, reverse = TRUE, ... )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/radialPolygon.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Plot a radial polygon — radialPolygon","text":"angle1 Angles inner line angle2 Angles outer line radius1 Radii inner line radius2 Radii outer line col Colour polygon border Border colour (see polygon() details) rot Rotation plot, defaults pi match dielPlot() yearlyPlot() angleinc angular increment radians calculating circular lines reverse FALSE plots anti-clockwise direction ... parameters passed polygon()","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/rainfallDetection.html","id":null,"dir":"Reference","previous_headings":"","what":"Rainfall detection — rainfallDetection","title":"Rainfall detection — rainfallDetection","text":"Detects rainfall Wave. uncalibrated version Bedoya et al (2017) doi:10.1016/j.ecolind.2016.12.018 available package. hardRain package can also accessed via wrapper.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/rainfallDetection.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Rainfall detection — rainfallDetection","text":"","code":"rainfallDetection(wave, method = \"bedoya2017\", ...)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/rainfallDetection.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Rainfall detection — rainfallDetection","text":"wave Wave object detect rainfall method rainfall detection method use (\"bedoya2017\") ... arguments pass rain detection function","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/rainfallDetection.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Rainfall detection — rainfallDetection","text":"Numeric value rainfall detection algorithm chosen.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/rainfallDetection.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Rainfall detection — rainfallDetection","text":"","code":"if (FALSE) { # \\dontrun{ rainfallDetection(sheep, method=\"bedoya2017\") } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readAudacityLabels.html","id":null,"dir":"Reference","previous_headings":"","what":"Read an Audacity label file — readAudacityLabels","title":"Read an Audacity label file — readAudacityLabels","text":"Reads Audacity label file returns either list Annotation objects data frame.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readAudacityLabels.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read an Audacity label file — readAudacityLabels","text":"","code":"readAudacityLabels(file, output = \"annotations\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readAudacityLabels.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read an Audacity label file — readAudacityLabels","text":"file Path Audacity label file. output One \"annotations\" \"data.frame\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readAudio.html","id":null,"dir":"Reference","previous_headings":"","what":"Read an audio file — readAudio","title":"Read an audio file — readAudio","text":"file used read audio file return Wave object, abstraction function various specific audio reading functions. existing method can identified attempt made use av package read audio.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readAudio.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read an audio file — readAudio","text":"","code":"readAudio(file, mime = \"auto\", from = 0, to = Inf, units = \"seconds\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readAudio.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read an audio file — readAudio","text":"file File read mime MIME type file read, \"auto\". Supported types \"audio/x-wav\" \"audio/mpeg\" (MP3) Start point file return End point file return units One \"samples\", \"seconds\", \"minutes\", \"hours\". Default \"seconds\".","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readAudio.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read an audio file — readAudio","text":"Wave object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readBirdNet.html","id":null,"dir":"Reference","previous_headings":"","what":"Read output files from BirdNet Analyser — readBirdNet","title":"Read output files from BirdNet Analyser — readBirdNet","text":"Reads single file, directory files, output BirdNet Analyser.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readBirdNet.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read output files from BirdNet Analyser — readBirdNet","text":"","code":"readBirdNet(file, filename_parsing = \"none\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readBirdNet.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read output files from BirdNet Analyser — readBirdNet","text":"file Filename directory filename_parsing Allows filename parsing, accepted values one none, audiomoth, timestamp.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readBirdNet.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read output files from BirdNet Analyser — readBirdNet","text":"data frame.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readRespeaker6.html","id":null,"dir":"Reference","previous_headings":"","what":"Read a file from Seeed Studio Respeaker 6 mic array — readRespeaker6","title":"Read a file from Seeed Studio Respeaker 6 mic array — readRespeaker6","text":"Seeed Studio Respeaker-6 used described documentation saves eight channel audio file channels 7 8 containing input audio. function reads file saves six channel file.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readRespeaker6.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Read a file from Seeed Studio Respeaker 6 mic array — readRespeaker6","text":"","code":"readRespeaker6(filename, from = 1, to = Inf, units = \"samples\", header = FALSE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readRespeaker6.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Read a file from Seeed Studio Respeaker 6 mic array — readRespeaker6","text":"filename file read. start reading wave units. stop reading wave units. units Units given, default \"samples\", can set time intervals \"seconds\". header TRUE, just header information Wave file returned, otherwise (default) whole Wave object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/readRespeaker6.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Read a file from Seeed Studio Respeaker 6 mic array — readRespeaker6","text":"WaveMC object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/referenceIntensity.html","id":null,"dir":"Reference","previous_headings":"","what":"Reference intensity — referenceIntensity","title":"Reference intensity — referenceIntensity","text":"Provides standard reference intensity level.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/referenceIntensity.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reference intensity — referenceIntensity","text":"","code":"referenceIntensity(unit = \"watt_cm2\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/referenceIntensity.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reference intensity — referenceIntensity","text":"unit Unit return, \"watt_cm2\"","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/referenceIntensity.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Reference intensity — referenceIntensity","text":"","code":"ri <- referenceIntensity()"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/referencePressure.html","id":null,"dir":"Reference","previous_headings":"","what":"Reference pressure — referencePressure","title":"Reference pressure — referencePressure","text":"Provides standard reference pressure level.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/referencePressure.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reference pressure — referencePressure","text":"","code":"referencePressure(unit = \"Pa\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/referencePressure.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reference pressure — referencePressure","text":"unit Unit return, \"Pa\" \"dyne_cm2\"","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/referencePressure.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Reference pressure — referencePressure","text":"","code":"rp <- referencePressure() rp <- referencePressure(unit=\"dyne_cm2\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/region.html","id":null,"dir":"Reference","previous_headings":"","what":"Specify a region with a file to analyse — region","title":"Specify a region with a file to analyse — region","text":"Specifies time-bounded region analyse.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/region.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Specify a region with a file to analyse — region","text":"","code":"region(unit, from = 0, to = Inf)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/region.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Specify a region with a file to analyse — region","text":"unit Unit time (one samples, seconds, minutes, hours) Start time End time","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/region.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Specify a region with a file to analyse — region","text":"TimeRegion object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/resonantFrequency.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate the resonant frequency — resonantFrequency","title":"Calculate the resonant frequency — resonantFrequency","text":"Calculates resonant frequency given inductance capacitance. acoustic case inductance inertia mass, capacitance elasticity (bulk modulus) resistance composed air resistance related quantities. units SI.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/resonantFrequency.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate the resonant frequency — resonantFrequency","text":"","code":"resonantFrequency(L, C = \"default\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/resonantFrequency.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate the resonant frequency — resonantFrequency","text":"L Inductance C Capacitance, default IUPAC standard pressure.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/resonantFrequency.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Calculate the resonant frequency — resonantFrequency","text":"isothermal compression, bulk modulus equal pressure. default value C therefore IUPAC standard pressure.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/resonantFrequency.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Calculate the resonant frequency — resonantFrequency","text":"","code":"f <- resonantFrequency(L=1)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sDuration.html","id":null,"dir":"Reference","previous_headings":"","what":"Sample duration — sDuration","title":"Sample duration — sDuration","text":"Calculates time represented n samples Wave.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sDuration.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sample duration — sDuration","text":"","code":"sDuration(n = 1, wave = NULL, samp.rate = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sDuration.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sample duration — sDuration","text":"n number samples wave Wave object containing pulses samp.rate Integer sampling rate","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sDuration.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sample duration — sDuration","text":"numeric value seconds","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sDuration.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Sample duration — sDuration","text":"","code":"sDuration(n=20, samp.rate=44100) #> [1] 0.0004535147 if (FALSE) { # \\dontrun{ sDuration(n=20, wave=sheep)#' } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sheepFrequencyStats.html","id":null,"dir":"Reference","previous_headings":"","what":"Sheep frequencyStats — sheepFrequencyStats","title":"Sheep frequencyStats — sheepFrequencyStats","text":"frequencyStats sheep data file seewave package.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sheepFrequencyStats.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sheep frequencyStats — sheepFrequencyStats","text":"","code":"sheepFrequencyStats"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sheepFrequencyStats.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Sheep frequencyStats — sheepFrequencyStats","text":"object class list length 3.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/shimmer.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate the shimmer in a Wave object — shimmer","title":"Calculate the shimmer in a Wave object — shimmer","text":"Jitter measure variability amplitudes within periods waveform. Relative shimmer scaled shimmer analysed waveform.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/shimmer.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate the shimmer in a Wave object — shimmer","text":"","code":"shimmer(wave)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/shimmer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate the shimmer in a Wave object — shimmer","text":"wave Wave object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/shimmer.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Calculate the shimmer in a Wave object — shimmer","text":"vector zero crossing locations","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/shimmer.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Calculate the shimmer in a Wave object — shimmer","text":"","code":"if (FALSE) { # \\dontrun{ shimmer(sheep) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/slash-PseudoWave-numeric-method.html","id":null,"dir":"Reference","previous_headings":"","what":"PseudoWave scalar division — /,PseudoWave,numeric-method","title":"PseudoWave scalar division — /,PseudoWave,numeric-method","text":"PseudoWave scalar division","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/slash-PseudoWave-numeric-method.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"PseudoWave scalar division — /,PseudoWave,numeric-method","text":"","code":"# S4 method for class 'PseudoWave,numeric' e1/e2"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/slash-PseudoWave-numeric-method.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"PseudoWave scalar division — /,PseudoWave,numeric-method","text":"e1 Input 1 e2 Input 2","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sort_annotations.html","id":null,"dir":"Reference","previous_headings":"","what":"Sort annotations — sort_annotations","title":"Sort annotations — sort_annotations","text":"Sorts list annotations either start time, frequency, .","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sort_annotations.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Sort annotations — sort_annotations","text":"","code":"sort_annotations(annotations, domain = \"time\", decreasing = FALSE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sort_annotations.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Sort annotations — sort_annotations","text":"annotations list Annotation objects. domain Domain annotations, either \"time\", \"frequency\", \"\". decreasing TRUE, sort decreasing order.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sort_annotations.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Sort annotations — sort_annotations","text":"list Annotation objects.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/soundSpeed.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate the speed of sound in a medium — soundSpeed","title":"Calculate the speed of sound in a medium — soundSpeed","text":"Given sufficient parameters (.e. wavelength frequency, bulk modulus density) function calculates speed sound.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/soundSpeed.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate the speed of sound in a medium — soundSpeed","text":"","code":"soundSpeed( medium = NULL, method = NULL, wl = NULL, f = NULL, bulkModulus = NULL, density = NULL, ... )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/soundSpeed.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate the speed of sound in a medium — soundSpeed","text":"medium Propagation medium (e.g. \"air\"), \"\" return list available media. method Use specific method calculate speed sound (see Details). wl Wavelength f Frequency bulkModulus Bulk modulus density Density ... Additional parameters passed method.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/soundSpeed.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Calculate the speed of sound in a medium — soundSpeed","text":"speed sound can calculated using following methods: cramer Uses method described cramer1993;textualsonicscrewdriver. Additional parameters : temp Temperature temp.unit Temperature unit pressure Pressure pressure.unit Pressure unit RH Relative humidity MoleFracCO2 Mole fraction CO2 seewave Delegates calculation speed sound air package seewave seewave2008sonicscrewdriver. calculation . performed \\(\\text{speed} = 331.4 + 0.6 \\times \\text{temp}\\). Additional parameters : temp Temperature","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/soundSpeed.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Calculate the speed of sound in a medium — soundSpeed","text":"","code":"soundSpeed(medium=\"air\") #> [1] 343 soundSpeed(medium=\"sea water\") #> [1] 1500 soundSpeed(method=\"cramer\", temp=14, pressure=3, RH=10) #> [1] 342.682 soundSpeed(method=\"cramer\", temp=14, temp.unit=\"C\", pressure=3, pressure.unit=\"kPa\", RH=10) #> [1] 342.682 t <- 1:30 s <- lapply(t, \\(x){soundSpeed(method=\"cramer\", temp=x)})"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/specStats.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate and plot statistics on a frequency spectrum — specStats","title":"Calculate and plot statistics on a frequency spectrum — specStats","text":"Given list outputs meanspec generates plot mean shown line, either minimum/maximum values one standard deviation shown ribbon.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/specStats.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate and plot statistics on a frequency spectrum — specStats","text":"","code":"specStats(spectra, stats = \"minMax\", line.col = \"black\", ribbon.col = \"grey70\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/specStats.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate and plot statistics on a frequency spectrum — specStats","text":"spectra list spectra stats Either minMax sd line.col Colour line ribbon.col Colour ribbon","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/specStats.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Calculate and plot statistics on a frequency spectrum — specStats","text":"ggplot2 object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/spectrogram_maad-class.html","id":null,"dir":"Reference","previous_headings":"","what":"An S4 class to represent a spectrogram from scikit-maad. — spectrogram_maad-class","title":"An S4 class to represent a spectrogram from scikit-maad. — spectrogram_maad-class","text":"S4 class represent spectrogram scikit-maad.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/spectrogram_maad-class.html","id":"slots","dir":"Reference","previous_headings":"","what":"Slots","title":"An S4 class to represent a spectrogram from scikit-maad. — spectrogram_maad-class","text":"Sxx spectrogram matrix tn time vector fn frequency vector extents extents spectrogram. list tmin, tmax, fmin, fmax.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ste.html","id":null,"dir":"Reference","previous_headings":"","what":"Short term energy — ste","title":"Short term energy — ste","text":"Computes short term energy Wave.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ste.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Short term energy — ste","text":"","code":"ste(wave, method = \"dietrich2004\", ...)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ste.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Short term energy — ste","text":"wave Wave object method method used calculate short term energy, default \"dietrich2004\" use dietrich2004sonicscrewdriver. ... arguments pass ste method.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ste.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Short term energy — ste","text":"vector short term energy values","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/ste.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Short term energy — ste","text":"","code":"if (FALSE) { # \\dontrun{ ste(sheep, method=\"dietrich2004\") } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sub-Wave-TimeRegion-method.html","id":null,"dir":"Reference","previous_headings":"","what":"Allow subsetting a Wave object with a TimeRegion — [,Wave,TimeRegion-method","title":"Allow subsetting a Wave object with a TimeRegion — [,Wave,TimeRegion-method","text":"Allow subsetting Wave object TimeRegion","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sub-Wave-TimeRegion-method.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Allow subsetting a Wave object with a TimeRegion — [,Wave,TimeRegion-method","text":"","code":"# S4 method for class 'Wave,TimeRegion' x[i]"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sub-Wave-TimeRegion-method.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Allow subsetting a Wave object with a TimeRegion — [,Wave,TimeRegion-method","text":"x Wave Object TimeRegion object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/subtractSpectra.html","id":null,"dir":"Reference","previous_headings":"","what":"Subtract two spectra from seewave — subtractSpectra","title":"Subtract two spectra from seewave — subtractSpectra","text":"function takes two spectra seewave (equivalent) subtracts values. spectra must bins.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/subtractSpectra.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Subtract two spectra from seewave — subtractSpectra","text":"","code":"subtractSpectra(s1, s2, coerceNegative = TRUE)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/subtractSpectra.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Subtract two spectra from seewave — subtractSpectra","text":"s1 First spectrum s2 Second spectrum coerceNegative Sets values zero zero output.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/subtractSpectra.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Subtract two spectra from seewave — subtractSpectra","text":"spectrum s1 - s2","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/subtractSpectra.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Subtract two spectra from seewave — subtractSpectra","text":"","code":"if (FALSE) { # \\dontrun{ subtractSpectra(spec1, spec2) subtractSpectra(spec1, spec2, coerceNegative=TRUE) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sweptsine.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a sine sweep — sweptsine","title":"Generate a sine sweep — sweptsine","text":"Generates frequency swept sine wave (either linear logarithmic) returns Wave object vector.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sweptsine.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a sine sweep — sweptsine","text":"","code":"sweptsine( f0 = 100, f1 = 2500, mode = \"linear\", sweep.time = 1, time.unit = \"seconds\", samp.rate = 44100, output = \"wave\", ... )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sweptsine.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a sine sweep — sweptsine","text":"f0 Start frequency f1 End frequency mode One \"linear\", \"log\" sweep.time Duration swept wave time.unit One \"seconds\", \"samples\" samp.rate Sample rate swept wave output \"wave\" Wave object, \"vector\" ... Additional arguments pass data2Wave","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sweptsine.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a sine sweep — sweptsine","text":"swept wave object type specified output.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/sweptsine.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a sine sweep — sweptsine","text":"","code":"#Generate a swept sine wave between 0Hz and 10kHz. w <- sweptsine(0, 10e3) #Generate a swept sine wave between 0Hz and 10kHz and normalise it. w <- normalise(sweptsine(0, 10e3)) #Generate a stereo swept sine wave between 100Hz and 1KHz. w <- tuneR::stereo(sweptsine(100, 1e3)) #Generate an exponentially swept sine wave between 100Hz and 1KHz. w <- sweptsine(100, 1e3, mode=\"log\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tSamples.html","id":null,"dir":"Reference","previous_headings":"","what":"Samples per time period — tSamples","title":"Samples per time period — tSamples","text":"Calculates number samples given duration wave","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tSamples.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Samples per time period — tSamples","text":"","code":"tSamples(time = 1, wave = NULL, samp.rate = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tSamples.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Samples per time period — tSamples","text":"time duration seconds wave Wave object containing pulses samp.rate Integer sampling rate","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tSamples.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Samples per time period — tSamples","text":"Number samples","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tSamples.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Samples per time period — tSamples","text":"","code":"tSamples(10, samp.rate=44100) #> [1] 441000 if (FALSE) { # \\dontrun{ tSamples(10, wave=sheep) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tagWave.html","id":null,"dir":"Reference","previous_headings":"","what":"Tag a Wave or WaveMC object — tagWave","title":"Tag a Wave or WaveMC object — tagWave","text":"function takes Wave/WaveMC object (list objects) returns corresponding tagged version (TaggedWave TaggedWaveMC).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tagWave.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Tag a Wave or WaveMC object — tagWave","text":"","code":"tagWave(w, origin = \"user\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tagWave.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Tag a Wave or WaveMC object — tagWave","text":"w Wave WaveMC object (list objects). origin origin object (default \"user\").","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tagWave.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Tag a Wave or WaveMC object — tagWave","text":"TaggedWave TaggedWaveMC object (list objects).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/times-PseudoWave-numeric-method.html","id":null,"dir":"Reference","previous_headings":"","what":"PseudoWave scalar manipulation — *,PseudoWave,numeric-method","title":"PseudoWave scalar manipulation — *,PseudoWave,numeric-method","text":"PseudoWave scalar manipulation","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/times-PseudoWave-numeric-method.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"PseudoWave scalar manipulation — *,PseudoWave,numeric-method","text":"","code":"# S4 method for class 'PseudoWave,numeric' e1 * e2"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/times-PseudoWave-numeric-method.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"PseudoWave scalar manipulation — *,PseudoWave,numeric-method","text":"e1 Input 1 e2 Input 2","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/times-numeric-PseudoWave-method.html","id":null,"dir":"Reference","previous_headings":"","what":"Numeric multiplication by PseudoWave — *,numeric,PseudoWave-method","title":"Numeric multiplication by PseudoWave — *,numeric,PseudoWave-method","text":"Numeric multiplication PseudoWave","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/times-numeric-PseudoWave-method.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Numeric multiplication by PseudoWave — *,numeric,PseudoWave-method","text":"","code":"# S4 method for class 'numeric,PseudoWave' e1 * e2"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/times-numeric-PseudoWave-method.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Numeric multiplication by PseudoWave — *,numeric,PseudoWave-method","text":"e1 Input 1 e2 Input 2","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/typicalVolume.html","id":null,"dir":"Reference","previous_headings":"","what":"Typical volumes — typicalVolume","title":"Typical volumes — typicalVolume","text":"Typical volumes everyday things.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/typicalVolume.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Typical volumes — typicalVolume","text":"","code":"typicalVolume(thing = NA_character_)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/typicalVolume.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Typical volumes — typicalVolume","text":"thing Volume thing, missing returns volumes","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/typicalVolume.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Typical volumes — typicalVolume","text":"Typical volume thing dBA, thing parameter data frame volumes","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/typicalVolume.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Typical volumes — typicalVolume","text":"","code":"typicalVolume() #> thing dBA #> 1 steam engine 85 #> 2 printing works 87 #> 3 diesel electric generator 96 #> 4 screw-heading machine 101 #> 5 weaving shed 104 #> 6 sawmill chipper 105 #> 7 metalwork grinder 106 #> 8 wood-planing machine 108 #> 9 metal saw 110 #> 10 rock band 115 #> 11 boiler works 118 #> 12 metal hammering 118 #> 13 jet take-off 120 #> 14 rocket launch 160 typicalVolume(\"rocket launch\") #> [1] 160"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tzRot.html","id":null,"dir":"Reference","previous_headings":"","what":"Converts a timezone offset into a rotation — tzRot","title":"Converts a timezone offset into a rotation — tzRot","text":"Given timezone offset hours returns rotation radians apply values diel plot.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tzRot.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Converts a timezone offset into a rotation — tzRot","text":"","code":"tzRot(tz, init = pi)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/tzRot.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Converts a timezone offset into a rotation — tzRot","text":"tz Timezone numeric init Initial rotation. Defaults pi.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/untagWave.html","id":null,"dir":"Reference","previous_headings":"","what":"Untag a TaggedWave or TaggedWaveMC object — untagWave","title":"Untag a TaggedWave or TaggedWaveMC object — untagWave","text":"function takes TaggedWave/TaggedWaveMC object (list objects) returns corresponding Wave/WaveMC object (list objects).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/untagWave.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Untag a TaggedWave or TaggedWaveMC object — untagWave","text":"","code":"untagWave(w)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/untagWave.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Untag a TaggedWave or TaggedWaveMC object — untagWave","text":"w TaggedWave TaggedWaveMC object (list objects).","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/untagWave.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Untag a TaggedWave or TaggedWaveMC object — untagWave","text":"Wave WaveMC object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/untagWave.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Untag a TaggedWave or TaggedWaveMC object — untagWave","text":"","code":"if (FALSE) { # \\dontrun{ w <- noise(\"white\") tw <- tagWave(w) w2 <- untagWave(tw) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/upsample.html","id":null,"dir":"Reference","previous_headings":"","what":"Upsample a wave — upsample","title":"Upsample a wave — upsample","text":"Used upsample Wave object. upsampled sample rate must natural multiple current sample rate.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/upsample.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Upsample a wave — upsample","text":"","code":"upsample(wave, upsample.rate, method = \"basic\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/upsample.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Upsample a wave — upsample","text":"wave Wave object upsample. upsample.rate sample rate upsample . method \"basic\" linear, function interpolate NAs vector","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/upsample.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Upsample a wave — upsample","text":"resampled Wave object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/upsample.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Upsample a wave — upsample","text":"","code":"wave <- tuneR::sine(4000, samp.rate=44100) wave2 <- upsample(wave, 88200)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/validateIsWave.html","id":null,"dir":"Reference","previous_headings":"","what":"Check an object is a Wave object — validateIsWave","title":"Check an object is a Wave object — validateIsWave","text":"Helper function test input Wave object. create error .","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/validateIsWave.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check an object is a Wave object — validateIsWave","text":"","code":"validateIsWave(wave)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/validateIsWave.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check an object is a Wave object — validateIsWave","text":"wave Object test","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/windowing.html","id":null,"dir":"Reference","previous_headings":"","what":"Windowing Function for Wave Objects — windowing","title":"Windowing Function for Wave Objects — windowing","text":"Separates Wave object windows defined length runs function window section. Windows may overlap, function can make use 'parallel' package multi-core processing. also show progress bar 'pbapply' package installed.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/windowing.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Windowing Function for Wave Objects — windowing","text":"","code":"windowing( wave, window.length = 1000, FUN, window.overlap = 0, bind.wave = FALSE, complete.windows = TRUE, cluster = NULL, ... )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/windowing.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Windowing Function for Wave Objects — windowing","text":"wave Wave object filename. Using filenames may save loading entire large file memory. window.length length analysis window (samples). FUN FUN applied windows. window.overlap overlap successive windows (samples), negative value result gap windows. bind.wave TRUE FUN returns wave objects, combined single object complete.windows TRUE (default) final window processed unless length equal window.length. cluster cluster form 'parallel' package multi-core computation. ... Additional parameters FUN","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/windowing.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Windowing Function for Wave Objects — windowing","text":"","code":"if (FALSE) { # \\dontrun{ windowing(wave, window.length=1000, FUN=duration, window.overlap=0, bind.wave=TRUE) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/writeAnnotationWave.html","id":null,"dir":"Reference","previous_headings":"","what":"Save a time region defined by an Annotation object as a Wave file — writeAnnotationWave","title":"Save a time region defined by an Annotation object as a Wave file — writeAnnotationWave","text":"Save time region defined Annotation object Wave file","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/writeAnnotationWave.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Save a time region defined by an Annotation object as a Wave file — writeAnnotationWave","text":"","code":"writeAnnotationWave(annotation, wave = NULL)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/writeAnnotationWave.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Save a time region defined by an Annotation object as a Wave file — writeAnnotationWave","text":"annotation Annotation object. wave (Optional) Wave object, given load wave file Annotation filename.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/writeAudacityLabels.html","id":null,"dir":"Reference","previous_headings":"","what":"Write an Audacity label file — writeAudacityLabels","title":"Write an Audacity label file — writeAudacityLabels","text":"Writes list Annotation objects Audacity label file. Internally uses write.audacity() function seewave package seewave2008sonicscrewdriver.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/writeAudacityLabels.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Write an Audacity label file — writeAudacityLabels","text":"","code":"writeAudacityLabels(annotations, file)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/writeAudacityLabels.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Write an Audacity label file — writeAudacityLabels","text":"annotations list Annotation objects. file Path Audacity label file.","code":""},{"path":[]},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyFraction.html","id":null,"dir":"Reference","previous_headings":"","what":"Calculate the fraction of a year given by a value — yearlyFraction","title":"Calculate the fraction of a year given by a value — yearlyFraction","text":"Given object can coerced POSIXlt, return fraction year represented object.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyFraction.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Calculate the fraction of a year given by a value — yearlyFraction","text":"","code":"yearlyFraction(t, year = 2022, input = \"POSIX\", unit = \"radians\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyFraction.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Calculate the fraction of a year given by a value — yearlyFraction","text":"t Object converted fraction year Year calculate fractions (allows leap years) input One POSIXlt (default) unit set radians outputs position around circle. set fraction outputs raw fraction.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyLabels.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate labels for a yearly plot — yearlyLabels","title":"Generate labels for a yearly plot — yearlyLabels","text":"Generates monthly labels yearlyPlot()..","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyLabels.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate labels for a yearly plot — yearlyLabels","text":"","code":"yearlyLabels()"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyPlot.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a yearly plot — yearlyPlot","title":"Create a yearly plot — yearlyPlot","text":"ToDO......","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyPlot.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a yearly plot — yearlyPlot","text":"","code":"yearlyPlot( year = 2022, lat, lon, limits = c(0, 2), plot = NULL, method = \"plotrix\", legend = F )"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyPlot.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a yearly plot — yearlyPlot","text":"year Year plot (allows leap years). lat Numeric latitude. lon Numeric longitude. limits Plotting limits daylight regions, default c(1,2) plot Character vector components plot method Plotting library use legend Whether show legend","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyPositions.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate positions of labels for a yearly plot — yearlyPositions","title":"Generate positions of labels for a yearly plot — yearlyPositions","text":"Generates positions monthly labels dielPlot() radians. positions can either start month, middle month.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyPositions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate positions of labels for a yearly plot — yearlyPositions","text":"","code":"yearlyPositions(year = 2022, format = \"months\")"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyPositions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate positions of labels for a yearly plot — yearlyPositions","text":"year Year calculate format One months, mid-months, days","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/yearlyPositions.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Generate positions of labels for a yearly plot — yearlyPositions","text":"function allows leap years year parameter provided.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zeroSpectrum.html","id":null,"dir":"Reference","previous_headings":"","what":"Zero spectrum — zeroSpectrum","title":"Zero spectrum — zeroSpectrum","text":"function takes spectrum seewave creates new zero-valued spectrum structure.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zeroSpectrum.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Zero spectrum — zeroSpectrum","text":"","code":"zeroSpectrum(s1)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zeroSpectrum.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Zero spectrum — zeroSpectrum","text":"s1 Spectrum emulate structure .","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zeroSpectrum.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Zero spectrum — zeroSpectrum","text":"zero-valued spectrum.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zeroSpectrum.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Zero spectrum — zeroSpectrum","text":"","code":"if (FALSE) { # \\dontrun{ zeroSpectrum(spec) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zerocross.html","id":null,"dir":"Reference","previous_headings":"","what":"Identify zero crossings in a Wave object — zerocross","title":"Identify zero crossings in a Wave object — zerocross","text":"Returns vector position (samples) zero crossings Wave object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zerocross.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Identify zero crossings in a Wave object — zerocross","text":"","code":"zerocross(wave)"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zerocross.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Identify zero crossings in a Wave object — zerocross","text":"wave Wave object","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zerocross.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Identify zero crossings in a Wave object — zerocross","text":"vector zero crossing locations","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/reference/zerocross.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Identify zero crossings in a Wave object — zerocross","text":"","code":"if (FALSE) { # \\dontrun{ zerocross(sheep) } # }"},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"sonicscrewdriver-007","dir":"Changelog","previous_headings":"","what":"sonicscrewdriver 0.0.7","title":"sonicscrewdriver 0.0.7","text":"CRAN release: 2024-05-11","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"new-functionality-0-0-7","dir":"Changelog","previous_headings":"","what":"New functionality","title":"sonicscrewdriver 0.0.7","text":"sweptsine() can generate logarithmic sweeps mode=“log” normalise() wrapper tuneR::normalize() detect bit depth data2Wave() uses new normalise() wrapper","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"documentation-0-0-7","dir":"Changelog","previous_headings":"","what":"Documentation","title":"sonicscrewdriver 0.0.7","text":"additional examples sweptsine()","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"fixes-0-0-7","dir":"Changelog","previous_headings":"","what":"Fixes","title":"sonicscrewdriver 0.0.7","text":"internal function normalise spectrum better testing bind.wave parameter windowing().","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"sonicscrewdriver-006","dir":"Changelog","previous_headings":"","what":"sonicscrewdriver 0.0.6","title":"sonicscrewdriver 0.0.6","text":"CRAN release: 2024-03-01","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"fixes-0-0-6","dir":"Changelog","previous_headings":"","what":"Fixes","title":"sonicscrewdriver 0.0.6","text":"issued identified Win build convert2seconds() numeric value < 1000 passed HHMM.","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"sonicscrewdriver-005","dir":"Changelog","previous_headings":"","what":"sonicscrewdriver 0.0.5","title":"sonicscrewdriver 0.0.5","text":"CRAN release: 2024-02-23","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"new-functionality-0-0-5","dir":"Changelog","previous_headings":"","what":"New functionality","title":"sonicscrewdriver 0.0.5","text":"use BirdNET-Analyzer within R using reticulate readAudio() generic function read audio files readAudacityLabels() read Audacity label files citation() information angle conversion Dolbear’s law audioblast() - search recordings analyses audioblast.org audioblastDownload() - Download files audioBlast allChannels analysing multi-channel audio read Respeaker6 formatted files","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"new-classes-0-0-5","dir":"Changelog","previous_headings":"","what":"New classes","title":"sonicscrewdriver 0.0.5","text":"Annotation class (recording manipulating annotations) PseudoWave class (e.g. apply noise file length) TaggedWaves class (document metadata processing) WaveFilter class (supports applying filters using pipes)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"fixes-0-0-5","dir":"Changelog","previous_headings":"","what":"Fixes","title":"sonicscrewdriver 0.0.5","text":"audiomothWave() fix (comments consistently placed header)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"sonicscrewdriver-004","dir":"Changelog","previous_headings":"","what":"sonicscrewdriver 0.0.4","title":"sonicscrewdriver 0.0.4","text":"CRAN release: 2021-05-02 support reading AudioMoth configuration files support reading AudioMoth metadata wave files audioRead function convert audio file types Wave object parseFilename now accepts POSIX timestamp format provides typical volumes (decibels)","code":""},{"path":"https://sonicscrewdriver.ebaker.me.uk/dev/news/index.html","id":"sonicscrewdriver-003","dir":"Changelog","previous_headings":"","what":"sonicscrewdriver 0.0.3","title":"sonicscrewdriver 0.0.3","text":"CRAN release: 2020-11-15 Jitter shimmer functions added.","code":""}] diff --git a/dev/sitemap.xml b/dev/sitemap.xml index f30472c..d0fc664 100644 --- a/dev/sitemap.xml +++ b/dev/sitemap.xml @@ -25,7 +25,6 @@ https://sonicscrewdriver.ebaker.me.uk/dev/reference/addSpectra.html https://sonicscrewdriver.ebaker.me.uk/dev/reference/allChannels.html https://sonicscrewdriver.ebaker.me.uk/dev/reference/annotation.html -https://sonicscrewdriver.ebaker.me.uk/dev/reference/annotations_merge.html https://sonicscrewdriver.ebaker.me.uk/dev/reference/audio_filesize.html https://sonicscrewdriver.ebaker.me.uk/dev/reference/audioblast.html https://sonicscrewdriver.ebaker.me.uk/dev/reference/audioblastDownload.html @@ -64,7 +63,7 @@ https://sonicscrewdriver.ebaker.me.uk/dev/reference/dolbear.html https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_can_merge.html https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_check_overlap.html -https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-annotation_merge_overlapping.html +https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-merge_annotations.html https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-spectrogram_maad_power.html https://sonicscrewdriver.ebaker.me.uk/dev/reference/dot-spectrum_maad.html https://sonicscrewdriver.ebaker.me.uk/dev/reference/dutyCycle.html @@ -97,6 +96,7 @@ https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_events.html https://sonicscrewdriver.ebaker.me.uk/dev/reference/maad_temporal_median.html https://sonicscrewdriver.ebaker.me.uk/dev/reference/map2RGB.html +https://sonicscrewdriver.ebaker.me.uk/dev/reference/merge_annotations.html https://sonicscrewdriver.ebaker.me.uk/dev/reference/naturalFrequency.html https://sonicscrewdriver.ebaker.me.uk/dev/reference/normalise.html https://sonicscrewdriver.ebaker.me.uk/dev/reference/ntd.html