Skip to content

Commit

Permalink
Updated README with shiny links
Browse files Browse the repository at this point in the history
  • Loading branch information
TGuillerme committed Oct 1, 2019
1 parent ab2caf4 commit 4c6cabb
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 11 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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!**

Expand All @@ -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!**
Expand Down
4 changes: 2 additions & 2 deletions rsconnect/shinyapps.io/tguillerme/moms.dcf
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ account: tguillerme
server: shinyapps.io
hostUrl: https://api.shinyapps.io/v1
appId: 1266739
bundleId: 2457650
bundleId: 2457663
url: https://tguillerme.shinyapps.io/moms/
when: 1569902328.1141
when: 1569902668.87661

0 comments on commit 4c6cabb

Please sign in to comment.