Update installation instructions
The current installation method for the baseflow package requires manually setting up a build environment with Rtools on Windows or gcc on Linux/macOS, installing Rust (cargo and rustup) with careful configuration of the PATH variable, downloading source or binary package files, and then installing via R commands. This complex process also involves manually uninstalling Rust after installation to avoid side effects.
What to change
The package can be installed directly from our GitLab repository using just two simple R commands:
install.packages("remotes")
remotes::install_gitlab("HYCAR-Hydro/baseflow",
host = "gitlab.irstea.fr",
dependencies = TRUE,
force = TRUE)
This method automatically manages dependencies and installation, eliminating the need for manual compilation setup or Rust toolchain management.
Action items
- Remove the INSTALL file containing the previous instructions
- Add clear explanations in the README file highlighting the simplified installation