dismapr: NOAA DisMAP data retrieval R package

R package that provides functions to easily interact with NOAA’s DisMAP (Distribution Mapping and Analysis Portal) APIs

Overview

DisMapR is an R package that provides functions to easily interact with NOAA’s NOAA’s DisMAP - Distribution Mapping and Analysis Portal APIs listed here:

• NOAA Distribution Mapping and Analysis Portal (DisMAP) | InPort

This package allows users to get and plot:

1. Surveys
   Survey location points
2. Rasters
   Rasters of interpolated biomass distribution
3. Indicators
   Indicators of overall distributional shifts in center of gravity by depth and location

Installation

# install required R packages
install.packages("RcppSimdJson")
install.packages("arcgis", repos = "https://r-arcgis.r-universe.dev")

# install dismapr R package from Github
devtools::install_github("bbest/dismapr")

Usage

See Getting Started

Disclaimers

URLs for the DisMAP services may change as new data releases become available. Check the DisMAP InPort page for the most up-to-date URLs.

Developer

The package is currently in development and may not include all features or be fully tested.

History

The initial script DisMAP_Data_Download_API.R was written by Melissa Karp, adapted by Claude.ai into an initial R package (see chat.md), then modified by Ben Best for expanded and working functionality.

Commands

Common tasks for package development include:

# update documentation after modifying any R/*.R files
devtools::document()

# preview website
pkgdown::build_site()

Documentation

Note that the documentation website https://bbest.github.io/dismapr is rendered from source by this Github Action:

• .github/workflows/pkgdown.yaml
  • pkgdown.yaml · Workflow runs

Next

Potential next steps to do:

• Consider get_dm_raster_series() to combine layers years and/or species
• Explore arcgislayers::arc_raster() for get_dm_raster()
• Consider plotting enhancements:
  • static:
    • map:
      • vector: visualise sf objects with ggplot2
      • raster: geom_raster() with ggplot2
      • basemap:
        • rnaturalearth
        • basemaps
  • interactive:
    • plot: plotly::ggplotly()
    • map: leaflet
• Use jsonld to extract from InPort, eg:
  • Survey Catch-per-unit-effort CURRENT | InPort
• Generate animated GIFs, per Claude.ai suggestion in example_script.r

Contributing

Contributions are welcome! If you have suggestions for improvements or new features, please open an issue or submit a pull request.

References

• NOAA DisMAP portal: https://apps-st.fisheries.noaa.gov/dismap/DisMAP.html
• Technical documentation: https://www.fisheries.noaa.gov/inport/item/66799

Citation

If using this package for research, please cite both the package and the NOAA DisMAP data sources.