From 2b372ace64450364a88d07fde8768688e44e4894 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20N=C3=BCst?= Date: Fri, 27 Mar 2015 12:25:22 +0100 Subject: [PATCH] update readme --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7d6bac7..b92607a 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,8 @@ R CMD INSTALL sensorweb4R ## Documentation +### Demos + Take a look at the demos to see how to use the package: ```r @@ -44,6 +46,7 @@ install.packages("maptools") install.packages("mapdata") install.packages("rgdal") ``` + On Fedora/RedHat/CentOS you will need the following yum packages to be able to install `rgdal`: ```shell @@ -58,17 +61,21 @@ Depending on the version of the OS, you will probably not find a suitable `rgdal cd ~/Downloads/ sudo R CMD INSTALL -configure-args'-with-proj-include=/usr/local/lib' rgdal_0.9-1.tar.gz ``` -Then restart R or RStudio + +Then restart R or RStudio. +### Vignette + Futher user documentation is in the R help and the vignettes: ```r vignette(package = "sensorweb4R") -vignette("") ``` -When installed from source or GitHub, run the command [Rd2pdf](http://cran.r-project.org/doc/manuals/R-exts.html#index-R-CMD-Rd2pdf) in the parent directory of the package to create the reference manual, which describes all functions in the package: +### Reference manual + +When installed from source or GitHub, run the command [Rd2pdf](http://cran.r-project.org/doc/manuals/R-exts.html#index-R-CMD-Rd2pdf) on the regular command line from the parent directory of the package. This will create the reference manual, which describes all functions in the package: ``` R CMD Rd2pdf sensorweb4R