updated documentation

R/RStoolbox-package.R

@@ -6,7 +6,7 @@
 #'  
 #' \itemize{
 #'  \item \code{\link{readMeta}}:  import Landsat metadata from MTL or XML files
-#'  \item \code{\link{stackMeta}}, \code{\link{getMeta}: load Landsat bands based on metadata
+#'  \item \code{\link{stackMeta}}, \code{\link{getMeta}}: load Landsat bands based on metadata
 #'  \item \code{\link{readSLI} & \link{writeSLI}}: read and write ENVI spectral libraries
 #'  \item \code{\link{saveRSTBX} & \link{readRSTBX}}: save and re-import RStoolbox classification objects (model and map)
 #'  \item \code{\link{readEE}}: import and tidy EarthExplorer search results
@@ -19,7 +19,7 @@
 #'  \item \code{\link{topCor}}: topographic illumination correction
 #'  \item \code{\link{cloudMask} & \link{cloudShadowMask}}: mask clouds and cloud shadows in Landsat or other imagery which comes with a thermal band
 #'  \item \code{\link{classifyQA}}: extract layers from Landsat 8 QA bands, e.g. cloud confidence
-#'  \item \code{\link{encodeQA}} & \link{decodeQA}}: encode/decode Landsat 16-bit QA bands.
+#'  \item \code{\link{encodeQA} & \link{decodeQA}}: encode/decode Landsat 16-bit QA bands.
 #'  \item \code{\link{rescaleImage}}: rescale image to match min/max from another image or a specified min/max range
 #'  \item \code{\link{normImage}}: normalize imagery by centering and scaling
 #'  \item \code{\link{oneHotEncode}}: one-hot encode a raster or vector

README.md

@@ -12,22 +12,28 @@ For more details have a look at the [functions overview](https://bleutner.github
 ## Installation
 The package is available on CRAN and can be installed as usual via
 
-    install.packages("RStoolbox")
-
+```R
+install.packages("RStoolbox")
+```
 
 To install the latest version from GitHub you need to have r-base-dev (Linux) or Rtools (Windows) installed.
 Then run the following lines:
 
-    library(devtools)
-    install_github("bleutner/RStoolbox")
+```R
+library(devtools)
+install_github("bleutner/RStoolbox")
+```
 
 ## Get started
 
-*to be added*
+`RStoolbox` implements a variety of remote sensing methods and workflows. Below are a few examples to get started. Further examples can be found in the [documentation of the respective functions](https://bleutner.github.io/RStoolbox/reference/index.html).
 
-### Example 1
+### Example 1: Classifications
+
+The example below shows an unsupervised classification workflow:
+
+```R
 
-*to be added*
 
 ### Example 2