Skip to content

TGuillerme/moms

Folders and files

NameName
Last commit message
Last commit date

Latest commit

99b8f21 · Oct 1, 2019
Oct 1, 2019
Sep 3, 2019
Oct 1, 2019
Oct 1, 2019
Oct 1, 2019
Jul 11, 2019
Mar 15, 2019
Aug 23, 2019
Oct 1, 2019
Oct 1, 2019
Mar 15, 2019
Oct 1, 2019
Oct 1, 2019
Oct 1, 2019
Oct 1, 2019
Jul 18, 2019
Oct 1, 2019
Apr 5, 2019
Mar 28, 2019
Oct 1, 2019

Repository files navigation

Build Status Project Status: Active - The project has reached a stable, usable state and is being actively developed.

moms: Measuring Occupancy in Multidimensional Space.

What is moms?

moms is a shiny app that helps understanding the multidimensional space occupancy metrics that can be used in ecology and evolution.

What isn't moms?

moms is not a package for measuring disparity! Although moms is distributed as a binary R package, it only contains functions for running the shiny app and making the paper associated with moms fully reproducible. These functions allow the reduce the space, make fancy plots or wrap up analysis in the context of the shiny app or the paper only. If you want to measure disparity, we highly recommend the use of the dispRity R package which is used by moms for all the disparity calculations.

Check out the presentation associated with the project.

Running moms online

Super easy! Simply click on the following link:

Running moms localy on your web browser

Not hard! In R, simply copy/paste the following:

if(!require(devtools)) install.packages("devtools")
if(!require(shiny)) install.packages("shiny")
runGitHub("moms", "TGuillerme")

Running moms in your R console

Not much more complicated! In R, copy/paste the following:

## Installing the App:
if(!require(devtools)) install.packages("devtools")
devtools::install_github("TGuillerme/moms")

## Running the App (from the root of the repository, i.e. <some_path_in_my_machine>/moms/:
shiny::runApp(".")

Check out the app manual for more details on moms GUI possibilities.

Associated paper

By the following associated paper: Shifting spaces: which disparity or dissimilarity metrics best summarise occupancy in multidimensional spaces?. This paper details the behaviour of several disparity metrics and discuss the advantages and disadvantages of using them (or not). This paper is also fully reproducible!

How to reproduce the paper?

To reproduce the paper you can follow these steps:

  1. Open the file /inst/shiftingspace.Rmd with your favourite Rmarkdown editor (Rstudio, Sublime, Atom, etc.).
  2. Press on the compile button.
  3. Your reproduced paper should now be in the inst/ directory.

Alternatively, you can directly compile the paper in html from the R console using:

## Compiling the paper in html
rmarkdown::render("inst/shiftingspace.Rmd", html_document())

Authors

Thomas Guillerme, Mark Puttick, Ariel Marcy, Vera Weisbecker

Citations

If you are using this package, please send an email so that we can generate some DOI you can cite.

NOTE HOWEVER THAT THIS IS AN EARLY STAGE OF THE APP/PAPER AND THAT IT CAN CHANGE SIGNIFICANTLY!