han-tun / pixelate

R package to pixelate and map spatially continuous point estimates according to the uncertainty that surrounds them

pixelate

An R package that varies pixel sizes to show uncertainty in geostatistical/geospatial maps

Prerequisites

The package pixelate is an R package. It was developed in R version 3.6.1 (2019-07-05) using RStudio. To download and install R please go to cran.r-project.org. To download and install RStudio please go to rstudio.com. Please ensure you have the latest version of R or at least version 3.5.0.

Installation

A development version of pixelate is available on Github. It can be installed in R using install_github from the latest version of the devtools package (version 2.3.0 as of May 2020) or at least version 2.2.1.9000. To ensure pixelate installs and the vignette builds, please follow the code below and accept any suggested package updates.

Please be aware, the vignette takes several minutes to build (up to five on an Early 2015 MacBook Pro) because it includes plots that are slow to generate. Apologies for the wait and thank you for your patience.

# Step 1) install devtools as required: 

if (!require("devtools")) { # If devtools is not intalled
  
  # Install stable version from CRAN:  
  install.packages("devtools") 

} else { # If devtools is already intalled  
  
  # Extract and compare the installed version: 
  vdevtools = packageVersion("devtools")
  vcompare = compareVersion(as.character(vdevtools), '2.2.1.9000')
  
  if (vcompare < 0) { # If the installed version is < ‘2.2.1.9000’
    
    # Install stable version from CRAN:  
    install.packages("devtools") 
  }
}


# Step 2) install pixelate from GitHub 
devtools::install_github("artaylor85/pixelate", build_vignettes = TRUE, dependencies = TRUE)

Usage

The pixelate package centres around a single function pixelate. To use pixelate and visualise its output following our examples, simply load and attach the pixelate package then read its vignette for both quick and detailed examples. In addition (and if you did not build the vignette upon installation), please see the documentation of pixelate (accessed by ?pixelate or help(pixelate)).

# load and attach
library(pixelate) 

# load the vignette for quick and detailed examples
vignette("pixelate") 

# Access documentation for pixelate()
?pixelate 

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT

Acknowledgements

Thank you to Pierre Jacob, Pamela Martinez, René Niehus and Pablo Martínez de Salazar for help testing package installation.