planktonr

R package that facilitates the download, analysis and visualisation of phytoplankton and zooplankton data.
https://github.com/planktonteam/planktonr

Category: Biosphere
Sub Category: Marine Life and Fishery

Last synced: about 5 hours ago
JSON representation

Repository metadata

r Package for the analysis and visualisation of plankton data

README.Rmd

          ---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# planktonr 


[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![Windows](https://github.com/PlanktonTeam/planktonr/actions/workflows/Windows.yaml/badge.svg)](https://github.com/PlanktonTeam/planktonr/actions/workflows/Windows.yaml)
[![Ubuntu](https://github.com/PlanktonTeam/planktonr/actions/workflows/Ubuntu.yaml/badge.svg)](https://github.com/PlanktonTeam/planktonr/actions/workflows/Ubuntu.yaml)
[![MacOS](https://github.com/PlanktonTeam/planktonr/actions/workflows/MacOS.yaml/badge.svg)](https://github.com/PlanktonTeam/planktonr/actions/workflows/MacOS.yaml)
[![Codecov test coverage](https://codecov.io/gh/PlanktonTeam/planktonr/branch/main/graph/badge.svg)](https://app.codecov.io/gh/PlanktonTeam/planktonr?branch=main)
[![issues - planktonr](https://img.shields.io/github/issues/PlanktonTeam/planktonr)](https://github.com/PlanktonTeam/planktonr/issues)


`planktonr` is an R package that facilitates the download, analysis, and visualisation of phytoplankton and zooplankton data. The package primarily focuses on plankton data from the Australian Ocean Data Network ([AODN](https://portal.aodn.org.au)) collected by the Integrated Marine Observing System ([IMOS](https://www.imos.org.au)), including:

* **National Reference Stations (NRS)** - Coastal monitoring stations with monthly sampling
* **Continuous Plankton Recorder (CPR)** - Ship-based transect sampling across ocean basins  
* **Southern Ocean Time Series (SOTS)** - Deep ocean mooring south of Tasmania

The package provides access to phytoplankton, zooplankton, larval fish, and biogeochemical data, along with tools for trend analysis, biodiversity assessment, and data visualisation.

## Installation

The package is under active development. You can install the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("PlanktonTeam/planktonr")
```

Some optional features require additional packages:
``` r
# For satellite data access
install.packages("thredds")

# For parallel processing (speeds up large data downloads)
install.packages(c("future", "furrr"))

# For community analysis functions
install.packages("vegan")
```

## Quick Start

```{r, eval=FALSE}
library(planktonr)
library(dplyr)
library(ggplot2)

# Get zooplankton biomass from NRS stations
df <- pr_get_Indices("NRS", "Zooplankton") %>%
  filter(Parameters == "Biomass_mgm3", 
         StationCode %in% c("MAI", "PHB"))

# Plot time series
pr_plot_TimeSeries(df, trans = "log10")

# Examine long-term trends
pr_plot_Trends(df, Trend = "Raw", method = "lm", trans = "log10")

# Look at seasonal patterns
pr_plot_Trends(df, Trend = "Month", method = "loess", trans = "log10")
```

## Key Features

### Data Access
* **`pr_get_NRSData()`** - Raw taxonomic data from NRS stations
* **`pr_get_CPRData()`** - Raw taxonomic data from CPR surveys
* **`pr_get_Indices()`** - Pre-calculated ecological indices (biomass, diversity, abundance)
* **`pr_get_FuncGroups()`** - Functional group abundance (diatoms, copepods, etc.)
* **`pr_get_NRSChemistry()`** - Nutrient and carbon chemistry data
* **`pr_get_NRSPigments()`** - Photosynthetic pigment concentrations

### Visualisation
* **`pr_plot_TimeSeries()`** - Basic time series plots
* **`pr_plot_Trends()`** - Time series with fitted trend lines
* **`pr_plot_Climatology()`** - Seasonal and annual climatologies
* **`pr_plot_tsfg()`** - Functional group composition over time
* **`pr_plot_EOVs()`** - Essential Ocean Variable plots for reporting

### Analysis
* **`pr_remove_outliers()`** - Statistical outlier detection and removal
* **`pr_add_Bioregions()`** - Assign samples to Australian marine bioregions
* **`pr_filter_data()`** - Helper for filtering datasets for analysis

## Learn More

See the package vignettes for detailed examples:
* `vignette("planktonr")` - Overview and sampling frequency maps
* `vignette("EssentialOceanVariables")` - EOV analysis and reporting
* `vignette("Phytoplankton")` - Phytoplankton data analysis examples
* `vignette("Zooplankton")` - Zooplankton data analysis examples
* `vignette("Biogeochemistry")` - Nutrient and pigment data
* `vignette("LarvalFish")` - Larval fish distribution data

## Acknowledgements

This package accesses data from the Integrated Marine Observing System (IMOS). IMOS is enabled by the National Collaborative Research Infrastructure Strategy (NCRIS) and is supported by the Australian Government.

Thanks to the Integration and Application Network ([ian.umces.edu/media-library](https://ian.umces.edu/media-library)) for the plankton symbols used in the planktonr hex sticker.

        

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 4 days ago

Total Commits: 900
Total Committers: 3
Avg Commits per committer: 300.0
Development Distribution Score (DDS): 0.411

Commits in past year: 131
Committers in past year: 3
Avg Commits per committer in past year: 43.667
Development Distribution Score (DDS) in past year: 0.466

Name Email Commits
Jason Everett j****t@g****m 530
clairedavies 2****s 367
copilot-swe-agent[bot] 1****t 3

Issue and Pull Request metadata

Last synced: 29 days ago

Total issues: 47
Total pull requests: 104
Average time to close issues: 7 months
Average time to close pull requests: 2 days
Total issue authors: 3
Total pull request authors: 2
Average comments per issue: 0.91
Average comments per pull request: 0.0
Merged pull request: 101
Bot issues: 0
Bot pull requests: 0

Past year issues: 5
Past year pull requests: 29
Past year average time to close issues: N/A
Past year average time to close pull requests: about 23 hours
Past year issue authors: 3
Past year pull request authors: 2
Past year average comments per issue: 0.0
Past year average comments per pull request: 0.0
Past year merged pull request: 27
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/planktonteam/planktonr

Top Issue Authors

  • jaseeverett (40)
  • clairedavies (6)
  • ric325 (1)

Top Pull Request Authors

  • jaseeverett (69)
  • clairedavies (35)

Top Issue Labels

  • enhancement (16)
  • bug (13)
  • high priority (12)
  • medium priority (7)
  • CodeFix (4)
  • low priority (2)
  • documentation (1)
  • help wanted (1)
  • question (1)

Top Pull Request Labels


Package metadata

proxy.golang.org: github.com/PlanktonTeam/planktonr

proxy.golang.org: github.com/planktonteam/planktonr


Dependencies

.github/workflows/test-coverage.yaml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran
  • R >= 2.10 depends
  • data.table * imports
  • dplyr * imports
  • ggplot2 * imports
  • htmltools * imports
  • leaflegend * imports
  • leaflet * imports
  • lubridate * imports
  • lutz * imports
  • magrittr * imports
  • patchwork * imports
  • purrr * imports
  • readr >= 2.0.0 imports
  • rlang * imports
  • rnaturalearth * imports
  • scales * imports
  • sf * imports
  • stats * imports
  • stringr * imports
  • suncalc * imports
  • tibble * imports
  • tidyr * imports
  • tidyselect * imports
  • units * imports
  • RNetCDF * suggests
  • covr * suggests
  • knitr * suggests
  • pracma * suggests
  • rmarkdown * suggests
  • rnaturalearthdata * suggests
  • testthat >= 3.0.0 suggests
  • thredds * suggests
  • yaImpute * suggests
  • zoo * suggests
.github/workflows/MacOS.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/Ubuntu.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/Windows.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/render-readme.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite

Score: -Infinity