Smithsonian/soundburst

Name: soundburst

Owner: Smithsonian Institution

Description: null

Created: 2016-10-12 20:48:45.0

Updated: 2017-11-07 19:43:06.0

Pushed: 2017-11-03 15:33:24.0

Homepage: null

Size: 90107

Language: R

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Soundburst README

Remote monitoring devices are evolving into an essential tool for biodiversity monitoring. In conjunction with Blue Raster, LLC, scientists at the Smithsonian Conservation Biology Institute created Soundburst, an acoustic application to rapidly process and identify species calls in sound files produced by remote sensors. Through Soundburst, we can pair acoustic recorders with eMammal cameras to monitor birds, frogs, and bats along with land-dwelling mammals.

The application was created using R and RShiny, with functions from R packages Seewave, Tuner, and Monitor. The app allows users to rename sound files, clip sound files to create files of a shorter duration, and generate spectrograms. Users can also annotate spectrograms with species identifications, and generate a csv of metadata and identifications. Finally, the user can choose to load these files to a cloud account.

Install Instructions
Windows
  1. First download and install R if you don't already have it installed. It is always better to download the latest version of R, however if you are having any issues with the SoundBurst App, please download the version of R with which it was developed with. The application was created and tested using R 3.3.1 which can be downloaded from here. If you prefer to use the latest version, you can obtain the install from here. Please note that you might need to run the installer as administrator on Windows.

  2. The next step is to download and install RStudio if you don't already have it installed. You can download the latest version of RStudio from here or download the version of RStudio with which SoundBurst App was developed with from here

  3. Since you will be running the SoundBurst App on Windows, it is necessary to also install RTools. Please download the latest version from here or version 3.4 which was used to during the app's development. Make sure that you select “Edit System Path” during the installation of Rtools so that it can be located and used by RStudio. See image below
    Rtools Edit System Path

  4. Once you have everything installed, you will need to download our source code from our github page. If you are a developer, please clone the master branch. Otherwise you can just click here to download the latest version of the Soundburst app.

  5. Once the code is downloaded, unzip the file.

  6. NOTE: if you are running Windows 10, you may encounter the following unexpected error (see image below). If you experience this error, please select “Do this for all current items” and click Skip. windows10-SoundBurst-App

  7. Once the file is unzipped, double click on soundBurst-site.Rproj. This will open RStudio. Click on installPackagesWin.r from the bottom right pane. In the top left pane, highlight all text and click the button “Run.” This installs the necessary packages for the app to run.

    Note that you might need to “Install additional tools”. Just click “yes” if asked.

  8. Next, open server.R file from the bottom right pane. Click “Run App” in the top left pane to launch the application.

If after you clicked on Run App you see an error similar to “Error: There is no package called: ..“, please try bullet point #6 and #7 once more and it should fix the problem. If the problem persists, please create a github issue and we will help you out.

Mac
  1. First download and install R if you don't already have it installed. It is always better to download the latest version of R, however if you are having any issues with the SoundBurst App, please download the version of R with which it was developed with. The application was created and tested using R 3.3.1 which can be downloaded from here. If you prefer to use the latest version, you can obtain the install from here.

  2. The next step is to download and install RStudio if you don't already have it installed. You can download the latest version of RStudio from here or download the version of RStudio with which SoundBurst App was developed with from here

  3. You will need to also download libxml. The easiest way to do that is to use Homebrew. If you do not have it installed on your Mac, please follow the instruction on their website. Once you have homebrew installed, just run the following commands: “$ brew install libxml2 libxslt” and “$ brew link libxml2 libxslt”

  4. Once you have everything installed, you will need to download the SoundBurst App from our github page. If you are a developer, please clone the master branch from here.

  5. Once the code is downloaded, unzip the file.

  6. Once the file is unzipped, double click on soundBurst-site.Rproj. This will open RStudio. Click on installPackagesMac-Linux.r from the bottom right pane. In the top left pane, highlight all text and click the button “Run.” This installs the necessary packages for the app to run.

    Note that you might need to “Install additional tools”. Just click “yes” if asked.

  7. Next, open server.R file from the bottom right pane. Click “Run App” in the top left pane to launch the application.

If after you clicked on Run App you see an error similar to “Error: There is no package called: ..“, please try bullet point #6 and #7 once more and it should fix the problem. If the problem persists, please create a github issue and we will help you out.

Linux (Desktop)
  1. First download and install R if you don't already have it installed. It is always better to download the latest version of R, however if you are having any issues with the SoundBurst App, please download the version of R with which it was developed with. Please go here, choose your Linux distribution and download the latest version of R OR download the version of R with which the SoundBurst App was developed R 3.3.1.

  2. The next step is to download and install RStudio if you don't already have it installed. Please go here and choose your Linux distribution to download the latest version of RStudio. If you want to download a previous version of RStudio (0.99.903 is not packaged for any Linux distribution), please go here

  3. Once you have everything installed, you will need to download the SoundBurst App from our github page. If you are a developer, please clone the master branch from here.

  4. Once the code is downloaded, unzip the file.

  5. Once the file is unzipped, double click on soundBurst-site.Rproj. This will open RStudio. Click on installPackagesMac-Linux.r from the bottom right pane. In the top left pane, click the button “Run.” This installs the necessary packages for the app to run. Note that you might need to “Install additional tools”. Just click “yes” if asked.

  6. Next, open server.R file from the bottom right pane. Click “Run App” in the top left pane to launch the application.

If after you clicked on Run App you see an error similar to “Error: There is no package called: ..“, please try bullet point #5 and #6 once more and it should fix the problem. If the problem persists, please create a github issue and we will help you out.wichga -Agc -m “Readme update"gp origin maer


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.