Skip to content

Commit

Permalink
readme fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
bbcrown committed Oct 22, 2018
1 parent 4176146 commit d10813a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 33 deletions.
8 changes: 4 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ R language and Shiny package were used as the main development tool for xROI, wh

### Installation
The xROI R package has been published on The Comprehensive R Archive Network (CRAN). The latest tested xROI package can be installed from the [CRAN packages repository](https://cran.r-project.org/web/packages/xROI) by running the following command in an R environment:
```{r, echo=TRUE}
```{r, echo=TRUE, eval=FALSE}
utils::install.packages('xROI', repos = "http://cran.us.r-project.org")
```

Alternatively, the latest beta release of xROI can be directly downloaded and installed from the GitHub repository:
```{r, echo=TRUE}
```{r, echo=TRUE, eval=FALSE}
devtools::install_github("bnasr/xROI")
Expand All @@ -29,15 +29,15 @@ xROI depends on many R packages including: raster, rgdal, sp, jpeg, tiff, shiny,
### Launch

A comprehensive user manual for low-level image processing using xROI is available from [xROI.pdf](https://cran.r-project.org/web/packages/xROI/xROI.pdf). While the user manual includes a set of examples for each function; here we explain the graphical interactive mode. The interactive mode can be launched from an interactive R environment by:
```{r, echo=TRUE}
```{r, echo=TRUE, eval=FALSE}
library(xROI)
Launch()
```

or form the command line (e.g. shell in Linux, Terminal in macOS and Command Prompt in Windows machines) where an R engine is already installed by:
```{shell, echo=TRUE}
```
Rscript -e “xROI::Launch(Interactive = TRUE)”
Expand Down
30 changes: 1 addition & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,12 @@ The xROI R package has been published on The Comprehensive R Archive Network (CR
utils::install.packages('xROI', repos = "http://cran.us.r-project.org")
```

```
## Installing package into '/usr/local/lib/R/site-library'
## (as 'lib' is unspecified)
```

Alternatively, the latest beta release of xROI can be directly downloaded and installed from the GitHub repository:

```r
devtools::install_github("bnasr/xROI")
```

```
## Downloading GitHub repo bnasr/xROI@master
## from URL https://api.github.com/repos/bnasr/xROI/zipball/master
```

```
## Warning in eapply(ns_env(pkg), force, all.names = TRUE): internal error -2
## in R_decompress1
```

```
## Installation failed: lazy-load database '/usr/local/lib/R/site-library/xROI/R/xROI.rdb' is corrupt
```

xROI depends on many R packages including: raster, rgdal, sp, jpeg, tiff, shiny, shinyjs, shinyBS, shinyAce, shinyTime, shinyFiles, shinydashboard, shinythemes, colourpicker, rjson, stringr, data.table, lubridate, plotly, moments, and RCurl. All the required libraries and packages will be automatically installed with installation of xROI. The package offers a fully interactive high-level interface as well as a set of low-level functions for ROI processing.

### Launch
Expand All @@ -52,17 +33,8 @@ library(xROI)
Launch()
```

```
## Warning: internal error -3 in R_decompress1
```

```
## Error in eval(expr, envir, enclos): lazy-load database '/usr/local/lib/R/site-library/xROI/R/xROI.rdb' is corrupt
```

or form the command line (e.g. shell in Linux, Terminal in macOS and Command Prompt in Windows machines) where an R engine is already installed by:

```shell
```
Rscript -e “xROI::Launch(Interactive = TRUE)”
Expand Down

0 comments on commit d10813a

Please sign in to comment.