-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ab2caf4
commit 4c6cabb
Showing
2 changed files
with
15 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,22 +10,26 @@ Check out the [presentation](https://figshare.com/articles/Guillerme_Evolution20 | |
### 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. | ||
### 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`](@@@biorXivlink@@@) 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](https://github.com/TGuillerme/dispRity) which is used by `moms` for all the disparity calculations. | ||
|
||
## Running moms on your web browser | ||
That's easy! In `R`, simply copy/paste the following: | ||
## Running `moms` online | ||
Super easy! Simply click on the following link: | ||
|
||
<a href="https://tguillerme.shinyapps.io/moms/"><img src="http://tguillerme.github.io/images/shiny.png" height="100" widht="100"/></a> | ||
|
||
## Running `moms` localy on your web browser | ||
Not hard! In `R`, simply copy/paste the following: | ||
```r | ||
if(!require(devtools)) install.packages("devtools") | ||
if(!require(shiny)) install.packages("shiny") | ||
runGitHub("moms", "TGuillerme") | ||
``` | ||
<!-- Upload the whole thing on shiny servers --> | ||
|
||
## Running moms in your R console | ||
## Running `moms` in your R console | ||
Not much more complicated! In `R`, copy/paste the following: | ||
```r | ||
## Installing the App: | ||
|
@@ -41,7 +45,7 @@ Check out the app [manual](https://raw.githack.com/TGuillerme/moms/master/inst/m | |
|
||
## Associated paper | ||
|
||
By the following associated paper: [Shifting spaces: how to summarise multidimensional spaces occupancy?](). | ||
By the following associated paper: [Shifting spaces: which disparity or dissimilarity metrics best summarise occupancy in multidimensional spaces?](@@@biorXivlink@@@). | ||
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!** | ||
|
||
|
@@ -67,7 +71,7 @@ Authors | |
|
||
Citations | ||
------- | ||
If you are using this package, please send [me](mailto:[email protected]) an email so that I can generate some DOI you can cite. | ||
If you are using this package, please send [an email](mailto:[email protected]) 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!** | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters