From 1e982bd0b450d2d67aa7f58684a225f3184b72a2 Mon Sep 17 00:00:00 2001 From: Jim Thorson <50178738+James-Thorson-NOAA@users.noreply.github.com> Date: Mon, 29 Jul 2024 14:09:09 -0700 Subject: [PATCH] Update README.md --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8b0acaf..f13cace 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,14 @@ # EcoState -State-space extension of EcoPath-with-EcoSim + +[![Documentation](https://img.shields.io/badge/documentation-EcoState-orange.svg?colorB=E91E63)](https://james-thorson-noaa.github.io/EcoState/) + +Package _EcoState_ fits a state-space mass-balance model intended for aquatic ecosystems, using mass-balance equations from matching and dynamical equations matching Ecosim. Unlike Ecopath with Ecosim (EwE), it fits both biological parameters (e.g., equilibrium biomass and predator-prey vulnerability) and measurement parameters (e.g., catchability coefficients) via fit to time-series data. It also estimates additional process errors representing nonstationarity in growth efficiency, ecotrophic efficient, migration, or other unmodeled processes. ## Installation -EcoState can be installed as a private repo. First click Code -> Download ZIP and save it locally. Then install it from that local copy: +EcoState can be installed from GitHub using: ``` r -library(devtools) -install_local([LOCAL PATH], dependencies = TRUE) +library(remotes) +install_github( "James-Thorson-NOAA/EcoState" ) ```