diff --git a/.gitignore b/.gitignore index a18df5a..b438c4a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,12 +1,8 @@ .Rhistory .Rapp.history .DS_Store -Ancillary/EnvironmentalData/CreateEnviro/Data/GEBCO_2014_2D.nc .Rproj.user -RawOutput/* -Ancillary/* inst/doc -docs /doc/ /Meta/ diff --git a/README.Rmd b/README.Rmd index 6444a9a..7b930de 100644 --- a/README.Rmd +++ b/README.Rmd @@ -29,7 +29,7 @@ knitr::opts_chunk$set( The Zooplankton Model of Size Spectra (ZooMSS) is a functional size-spectrum model of the marine ecosystem (following Heneghan et al. 2016) to resolve phytoplankton, nine zooplankton functional groups (heterotrophic flagellates and ciliates, omnivorous and carnivorous copepods, larvaceans, euphausiids, salps, chaetognaths and jellyfish) and three size-based fish groups. Zooplankton functional groups are resolved using their body-size ranges, size-based feeding characteristics and carbon content, and the zooplankton community emerges from the model across global environmental gradients, depending on the functional traits of the different groups. -We developed the Zooplankton Model of Size Spectra (ZooMSSv2) based on the prototype of Heneghan et al. (2016). ZooMSS uses the functional size-spectrum framework (Blanchard et al., 2017) to resolve the body size ranges, size-based feeding characteristics and carbon content of nine zooplankton groups and three fish groups. The model supports time-varying environmental conditions enabling studies of seasonal cycles, climate change scenarios, and ecosystem responses to environmental variability. +We developed the Zooplankton Model of Size Spectra ZooMSS based on the prototype of Heneghan et al. (2016). ZooMSS uses the functional size-spectrum framework (Blanchard et al., 2017) to resolve the body size ranges, size-based feeding characteristics and carbon content of nine zooplankton groups and three fish groups. The model supports time-varying environmental conditions enabling studies of seasonal cycles, climate change scenarios, and ecosystem responses to environmental variability. ZooMSS represents the marine ecosystem as three communities: phytoplankton, zooplankton and fish. The zooplankton community consists of nine of the most abundant zooplankton groups, and the fish community was made up of a small, medium and large group. Dynamics of the phytoplankton are not explicitly resolved in the model, rather the mean size structure of the phytoplankton community is estimated directly from satellite chlorophyll a observations (Brewin et al., 2010; Barnes et al., 2011; Hirata et al., 2011). Abundances of the zooplankton and fish communities are driven by size-dependent processes of growth and mortality, with the temporal dynamics of each functional group governed by separate second-order McKendrick-von Foerster equations. diff --git a/README.md b/README.md index 1086087..ea4e321 100644 --- a/README.md +++ b/README.md @@ -31,8 +31,8 @@ characteristics and carbon content, and the zooplankton community emerges from the model across global environmental gradients, depending on the functional traits of the different groups. -We developed the Zooplankton Model of Size Spectra (ZooMSSv2) based on -the prototype of Heneghan et al. (2016). ZooMSS uses the functional +We developed the Zooplankton Model of Size Spectra ZooMSS based on the +prototype of Heneghan et al. (2016). ZooMSS uses the functional size-spectrum framework (Blanchard et al., 2017) to resolve the body size ranges, size-based feeding characteristics and carbon content of nine zooplankton groups and three fish groups. The model supports diff --git a/_pkgdown.yml b/_pkgdown.yml index 8e95892..2f11983 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,7 +1,6 @@ url: ~ template: bootstrap: 5 - bootswatch: lumen bslib: toc: true toc-expand: 3 @@ -34,6 +33,3 @@ reference: desc: Functions to be unexported - contents: - untibble -navbar: - structure: - right: [github, search] diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 0000000..4bd8a7f --- /dev/null +++ b/docs/404.html @@ -0,0 +1,75 @@ + + +
+ + + + +YEAR: 2025 +COPYRIGHT HOLDER: zoomss authors ++ +
LICENSE.md
+ Copyright (c) 2025 zoomss authors
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ZooMSS requires two sets of input data:
+Groups - Contains all taxa-specific parameter +values for each model group, including size ranges and functional group +properties.
Environmental data - A Time-series dataframe
+with time series of environmental conditions with time,
+sst, and chl columns.
Get the default published Groups dataframe using:
+Groups <- getGroups()
+#> Using default ZooMSS functional groups. Use getGroups() to customize.Now create an environmental data time-series using the helper
+function. This time-series uses a constant sea surface temperature
+(sst) and chlorophyll a (chl) with a
+0.1 yr-1 timestep (dt).
+env_data <- createInputParams(time = seq(0, 100, by = 0.1) ,
+ sst = 15,
+ chl = 0.15)
+#> ZooMSS input parameters created:
+#> - Time points: 1001 (time values provided)
+#> - Time steps: 1000 (intervals to simulate)
+#> - Time range: 0 to 100 years
+#> - dt = 0.1 years
+#> - SST range: 15 to 15 deg C
+#> - Chlorophyll range: 0.15 to 0.15 mg/m^3We can look at the environment data and check everything is ok +with:
+
+plotEnvironment(env_data)
Now we run ZooMSS and save every isave timestep to
+reduce storage requirements.
+mdl <- zoomss_model(input_params = env_data, Groups = Groups, isave = 2)
+#> Functional groups validation passed
+#> Calculating phytoplankton parameters from environmental time seriesThe model includes several built-in plotting functions for analysis +and visualization.
+These plots display total abundance and mean growth/mortality across +all size classes through time.
+
+
+library(patchwork)
+p1 <- plotTimeSeries(mdl, by = "abundance", transform = "log10") # Plot abundance time series
+p2 <- plotTimeSeries(mdl, by = "growth") # Plot growth rate time series
+p3 <- plotTimeSeries(mdl, by = "mortality") # Plot predation mortality time series
+
+wrap_plots(p1, p2, p3, nrow = 3, guides = "collect")
We can also plot total biomass through time.
+
+p4 <- plotTimeSeries(mdl, by = "biomass", transform = "log10") + theme(legend.position = "none") # Plot biomass
+p5 <- plotTimeSeries(mdl, by = "biomass", type = "stack", transform = "log10") # Plot stacked biomass
+p6 <- plotTimeSeries(mdl, by = "biomass", type = "fill") # Plot proportional stacked biomass
+
+wrap_plots(p4, p5, p6, nrow = 3, guides = "collect")
Plot mean species-resolved size spectra for the final
+n_years.
+plotSizeSpectra(mdl, n_years = 10)
+#> Averaging final 10 years (50 saved time steps with isave = 2) of abundance from 500 total saved time steps.
Plot predator-prey mass ratios for the idx timestep
+plotPPMR(mdl, idx = 500) # Plot final timestep