Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
simplify
  • Loading branch information
cpanse authored May 21, 2019
1 parent 57ea188 commit 5eba913
Showing 1 changed file with 5 additions and 35 deletions.
40 changes: 5 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This package implements the [RecMap construction algorithm (MP2)](http://dx.doi.
## Installation


### from [CRAN](https://CRAN.R-project.org/package=recmap)
### use [CRAN](https://CRAN.R-project.org/package=recmap)

`recmap` requires R 3.3 or later.

Expand All @@ -24,39 +24,6 @@ and can be installed using the following code
install.packages('recmap')
```

### from [github](https://github.com/cpanse/recmap)

the code below installs the latest development version

```{r}
install.packages('devtools')
library(devtools)
install_github('cpanse/recmap', build_vignettes = TRUE, quiet = FALSE)
browseVignettes('recmap')
```

### Use the docker public | automated build [recmap image](https://hub.docker.com/r/cpanse/recmap/)

this image contains the latest build.

```{bash}
docker pull cpanse/recmap \
&& docker run -d -p 8791:8787 cpanse/recmap
```

connect to http://yourdockerhost:8791 using a web browser

* username: rstudio
* password: rstudio

or stand alone

```{bash}
docker run -it -p 8787:8787 cpanse/recmap R -e "library(shiny); recmap_shiny <- system.file('shiny-examples', package = 'recmap'); shiny::runApp(recmap_shiny, display.mode = 'normal', port=8787, host='0.0.0.0')"
```

connect to the docker host:8787

## Documentation

The package ships with a package
Expand All @@ -83,7 +50,7 @@ recmap_shiny <- system.file('shiny-examples', package = 'recmap')
shiny::runApp(recmap_shiny, display.mode = 'normal')
```

if you want to run the recmap shiny demonstration as stand-alone application
Run the recmap shiny demonstration as a stand-alone application
using Linux and Apple systems use the `Terminal` application add the following
code to your alias file, e.g., `$HOME/.bashrc`

Expand All @@ -93,6 +60,9 @@ alias recmapShiny="R -e \"library(shiny); \
shiny::runApp(recmap_shiny, display.mode = 'normal', launch.browser=TRUE)\""
```

execute

`. $HOME/.bashrc && recmapShiny`

## (Frequently) Asked Questions

Expand Down

0 comments on commit 5eba913

Please sign in to comment.