diff --git a/README.Rmd b/README.Rmd index 1fed369..ac62a8e 100644 --- a/README.Rmd +++ b/README.Rmd @@ -39,12 +39,11 @@ When comparing results across different software that calculate GLCM texture met ## Install and Load Package -If you don't already have remotes installed, use the code `install.packages("remotes")` - -Then to install this package use the code `remotes::install_github("ailich/GLCMTextures")` (If you are using Windows, you may need to install Rtools using the instructions found [here](https://cran.r-project.org/bin/windows/Rtools/)). +The package can be installed from CRAN using `install.packages("GLCMTextures")` or the development version can be installed from github using the code `remotes::install_github("ailich/GLCMTextures")`. If you are using Windows, you may need to install Rtools using the instructions found [here](https://cran.r-project.org/bin/windows/Rtools/)). To install from github you must already have the remotes package installed, which can be installed using `install.packages("remotes")` This package relies on the `terra` package for handling of spatial raster data. + ## Specifying the Relationship Between Focal and Neighbor Pixels The convention for specifying the direction of the neighboring pixel (the shift) is shown in the image below. The blue pixel in the center is treated as the focal pixel in the example. Shifts are specified as `c(x_shift, y_shift)`. So, a shift of `c(1,0)` refers to a the neighboring pixel being 1 to the right and 0 upwards of the focal pixel. Since a symmetric GLCM is created, this means each pixel is counted as both a focal and a neighboring pixel, so it also tabulates the shift in the opposite direction `c(-1,0)`, which is the dotted blue line. Therefore, these two shifts will produce equivalent results. Although neighboring pixels are typically considered as those one away in a given direction, the shift value can be specified as any integer value. diff --git a/README.md b/README.md index f2c0d18..f0fff54 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ README ================ Alexander Ilich -October 04, 2022 +October 05, 2022 @@ -46,13 +46,14 @@ how and if the data should be quantized. ## Install and Load Package -If you don’t already have remotes installed, use the code -`install.packages("remotes")` - -Then to install this package use the code -`remotes::install_github("ailich/GLCMTextures")` (If you are using +The package can be installed from CRAN using +`install.packages("GLCMTextures")` or the development version can be +installed from github using the code +`remotes::install_github("ailich/GLCMTextures")`. If you are using Windows, you may need to install Rtools using the instructions found -[here](https://cran.r-project.org/bin/windows/Rtools/)). +[here](https://cran.r-project.org/bin/windows/Rtools/)). To install from +github you must already have the remotes package installed, which can be +installed using `install.packages("remotes")` This package relies on the `terra` package for handling of spatial raster data.