Skip to content

LXiao06/ASAP

Repository files navigation

output github_document

ASAP ASAP

R-CMD-check

Overview

ASAP (Automated Sound Analysis Pipeline) is an R toolkit designed for the longitudinal analysis of birdsong development, specifically optimized for tracking and studying the long-term vocalization patterns of zebra finches.

The pipeline introduces a dedicated SAP object, which streamlines the processing of recordings from the SAP2011 system or other sound data organized with similar structures. Additionally, ASAP is built with flexibility in mind, allowing for the integration of other objects to ensure compatibility with various recording platforms.

Key Features

  • Bout Detection: Automatically identifies periods of singing within recordings.

  • Motif Extraction: Extracts recurring song motifs for in-depth analysis.

  • Syllable Segmentation: Breaks down songs into individual syllables for detailed study.

  • Template Matching: Compares and matches song patterns against predefined templates.

  • Feature Extraction: Extracts detailed temporal and spectral features from vocalizations.

  • Standardized Analytical Workflows: Utilizes predefined workflows for consistent and efficient analysis.

Installation

You can install the latest stable release of ASAP from GitHub:

# Install the latest stable release (recommended)
remotes::install_github("LXiao06/ASAP@*release")

Or install the development version with the latest features:

# Install the development version
remotes::install_github("LXiao06/ASAP")

Tutorials

Explore our guides to get up and running with ASAP. You can find all documentation on the ASAP website.

Quick Start

  • ASAP 101: Learn the single-file workflow with spectrograms, bout detection and export, and syllable segmentation.
  • Motif Detection: Introduction to automated motif extraction using template matching.
  • Acoustic Feature Analysis: Measure spectral entropy, pitch contours, and amplitude envelopes.

Longitudinal Analysis Pipeline

Step-by-step guides for processing large longitudinal datasets spanning multiple developmental time points:

  1. Constructing the SAP Object
  2. Longitudinal Bout Detection
  3. Longitudinal Motif Detection
  4. Longitudinal Syllable Segmentation
  5. Syllable Labeling
  6. Exporting Curated Song Clips

Acknowledgements

ASAP relies on the following R packages: seewave, tuneR, warbleR, monitoR, and av.

This work was inspired by the pioneering contributions of Ofer Tchernichovski et al. (Sound Analysis Pro, SAP 2011), Tim Sainburg (timsainb), Therese Koch (AVN), and Seurat (Butler et al.).

About

Automated Sound Analysis Pipeline for longitudinal analysis of birdsong development

Topics

Resources

License

Stars

Watchers

Forks

Contributors