/funbiogeo

:package: R package to help with analyses in functional biogeography

Primary LanguageRGNU General Public License v2.0GPL-2.0

funbiogeo

R-CMD-check codecov CRAN status License: GPL v2

Overview
Features
Installation
First steps
Long-form documentations
Citation
Contributing
Acknowledgments
References

Overview

The package funbiogeo aims to help users with analyses in functional biogeography (Violle et al. 2014) by loading and combining data, computing trait coverage, as well as computing functional diversity indices, drawing maps, correlating them with the environment, and upscaling assemblages.

It is aimed at first-timers of functional biogeography as well as more experienced users who want to obtain quick and easy exploratory plots.

Features

funbiogeo offers:

  • Standardized functions to filter and select your data for further analyses,
  • Pleasing default diagnostic plots to visualize the structure of your data,
  • Extensive documentation (multiple vignettes, well-documented functions, real-life example dataset) to guide you through functional biogeography analyses,
  • Nice default plotting functions using outputs from functional diversity packages (betapart, fundiversity, hillR, mFD, etc.),
  • Automated standardized report that provide analyses and plots of your data,
  • Functions to easily “upscale” your data to coarser spatial resolutions.

Installation

For the moment funbiogeo is not on CRAN but you can install the development version from GitHub as follow:

# install.packages("remotes")  # Run this line if 'remotes' pkg is not installed
remotes::install_github("FRBCesab/funbiogeo")

First steps

This section will show you some useful functions from funbiogeo. For a longer introduction please refer to the “Get started” vignette.

The package contains default example data named species_traits, site_species, and site_locations. You can for example visualize to completeness of your trait dataset using the fb_plot_species_traits_completeness() function:

fb_plot_species_traits_completeness(species_traits)

One other useful visualization is to see the trait coverage of each trait across all sites, using the function fb_map_site_traits_completeness():

fb_map_site_traits_completeness(site_locations, site_species, species_traits)

See more features of funbiogeo in the vignettes of the package

Long-form documentations

funbiogeo provides four vignettes to explain its functioning:

Citation

For the moment funbiogeo doesn’t offer a companion paper. But if you happen to use it in your paper you can cite the package through:

Casajus N & Grenié M (2024). funbiogeo: Functional Biogeography Analyses. R package version 0.0.0.9000, https://github.com/frbcesab/funbiogeo.

You can also run:

citation("funbiogeo")

Contributing

All types of contributions are encouraged and valued. For more information, check out our Contributor Guidelines.

Please note that the funbiogeo project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Acknowledgments

This package has been developed for the FRB-CESAB working group FREE that aims to advance the concept of functional rarity and examine the causes and consequences of functional rarity from local to global scales.

References

Violle C, Reich, PB Pacala SW, et al. (2014) The emergence and promise of functional biogeography. Proceedings of the National Academy of Sciences, 111, 13690–13696. DOI: 10.1073/pnas.1415442111