invasimapr 0.2.0
Release notes for invasimapr v0.2.0
🌿 A maturity & standards release for invasimapr
This release brings invasimapr in line with the B-Cubed software development guide, hardens the codebase, and overhauls the documentation — making the full traits → competition → invasion-fitness workflow easier to install, run, and cite. R CMD check now passes cleanly.
✨ Highlights
- Runnable quick-start — the README now ships a self-contained, copy-paste example that runs the pipeline end-to-end on the bundled demo data, from prepared inputs to species invasiveness and site invasibility.
- Standards-aligned — restructured to follow the B-Cubed guide, with a new Get started vignette and clean
b3doc/ pkgdown documentation builds. - Easier to cite — archived on Zenodo with a citable concept DOI (10.5281/zenodo.20842472) and machine-readable
CITATION.cff,codemeta.jsonand.zenodo.jsonmetadata.
📚 Documentation
- Rewrote the README around a minimal, reproducible workflow, with manuscript context and key figures.
- Moved the step-by-step tutorials into pkgdown Articles (introduction, step-by-step workflow, clustering & risk scenarios, computing invasion fitness, and invasion-fitness synthesis) and added a Get started vignette.
- Renamed the bundled
inputs_vignettes.rdstoinvasimapr_vignettes.rds. - Added a Darwin Core-aligned data dictionary at
inst/extdata/data_dictionary.csv.
🧹 Code quality
- Resolved the
R CMD checkWARNING and NOTEs (movedspto Suggests, qualifiedglmmTMB::ranef, fixedswitch(EXPR=), Rd line widths, and theCODE_OF_CONDUCTbuild ignore). - Slimmed the install from ~100 MB to ~56 MB — gzipped the demo CSV, dropped six unused
extdatafiles, and moved the vignette cache out of the build. - Removed dead code (
sigma_mat_from_vcov) and a redundantmagrittrdependency. - Declared
scalesandstringras explicit imports; replaced the deprecatedcitEntry()ininst/CITATIONwithbibentry(). DESCRIPTIONnow uses Title Case, with the maintainer ORCID and a copyright holder (Stellenbosch University).
⚙️ Compatibility
- Now requires R (≥ 4.1.0) — the package uses the native pipe
|>.
🧰 The workflow at a glance
Seven high-level wrappers span the pipeline — prepare_inputs(), prepare_trait_space(), model_residents(), learn_sensitivities(), predict_invaders(), predict_establishment() and summarise_results() — built on core functions including compute_invasion_fitness(), compute_establishment_probability() and summarise_invasiveness_invasibility(). compute_invasion_fitness() gains an opt-in standardise_inputs argument to re-standardise raw predictors onto a common z-scale before computing fitness (off by default).
🔜 Roadmap
- Additional metrics for functional trait dispersion and environmental filtering.
- Interactive visualisation tools and scenario exploration modules.
- Expanded vignettes and tutorials.
💬 Questions or bugs? Please use the GitHub issue tracker.
invasimapr is developed within the B-Cubed project (Biodiversity Building Blocks for policy), funded by the European Union's Horizon Europe programme (grant 101059592), and is designed to pair with dissmapr for biodiversity data preparation.