annotate run_idw_interpolation.R @ 0:d07fcc660f3c draft

planemo upload for repository https://github.com/galaxyecology/tools-ecology/tree/master/tools/interpolation commit 450e4496f243d6e94d5238358873bbc014fe2f08

library("getopt")
library("sf")
library("tmap")
library("RColorBrewer")
library("raster")
library("gstat")

args = commandArgs(trailingOnly=TRUE)
option_specification = matrix(c(
    'observationsCsv', 'i1', 1, 'character',
    'latitudeColumn', 'i2', 1, 'double',
    'longitudeColumn', 'i3', 1, 'double',
    'observationsColumn', 'i4', 1, 'double',
    'studyArea', 'i5', 1, 'character',
    'idwPower', 'i6', 1, 'double',
    'samplePoints', 'i7', 1, 'double',
    'sampleType', 'i8', 1, 'character',
    'legendLabel', 'i9', 1, 'character',
    'legendPosition', 'i10', 1, 'character',
    'numberClasses', 'i11', 1, 'double',
    'dotSize', 'i12', 1, 'double',
    'colorType', 'i13', 1, 'character',
    'testCase', 'i14', 1, 'character',
    'outputData', 'o', 2, 'character'
), byrow=TRUE, ncol=4);
options = getopt(option_specification);

obsData <- read.csv(file=options$observationsCsv, sep = ',', header = TRUE)
latitudeColumn <- options$latitudeColumn
longitudeColumn <- options$longitudeColumn
observationsColumn <- options$observationsColumn
studyArea <- options$studyArea
idwPower <- options$idwPower
samplePoints <- options$samplePoints
sampleType <- options$sampleType
legendLabel <- options$legendLabel
legendPosition <- options$legendPosition
numberClasses <- options$numberClasses
dotSize <- options$dotSize
colorType <- options$colorType
testCase <- options$testCase

#cat("\n observationsCsv", options$observationsCsv)
cat("\n latitudeColumn", latitudeColumn)
cat("\n longitudeColumn", longitudeColumn)
cat("\n observationsColumn", observationsColumn)
#cat("\n studyArea", studyArea)
cat("\n idwPower", idwPower)
cat("\n samplePoints", samplePoints)
cat("\n sampleType", sampleType)
cat("\n legendLabel", legendLabel)
cat("\n legendposition", legendPosition)
cat("\n numberClasses", numberClasses)
cat("\n dotSize", dotSize)
cat("\n colorType", colorType)
cat("\n testCase", testCase)
#cat("\n outputData: ", options$outputData)

coordinates(obsData) <- c(colnames(obsData)[longitudeColumn], colnames(obsData)[latitudeColumn])
sf_obsData <- as_Spatial(st_as_sf(obsData))

polygon <- as_Spatial(st_read(studyArea))
sf_obsData@bbox<-polygon@bbox

runInterpolation <- function(points, values, interpolation_power, sample_points, sample_type){
  if (testCase == "true") {
    cat("\n set seed!")
    set.seed(123)
  }
  grd              <- as.data.frame(spsample(points, sample_type, n=sample_points))
  names(grd)       <- c("X", "Y")
  coordinates(grd) <- c("X", "Y")
  gridded(grd)     <- TRUE
  fullgrid(grd)    <- TRUE
  
  proj4string(points) <- proj4string(points)
  proj4string(grd) <- proj4string(points)
  return(gstat::idw(values ~ 1, points, newdata=grd, idp=interpolation_power))
}

plotInterpolationMap <- function(raster, points, legend_label){
  plot <- tm_shape(raster) + 
    tm_raster(n=numberClasses,palette = rev(brewer.pal(7, colorType)), auto.palette.mapping = FALSE,
              title=legend_label) +
    tm_shape(points) + tm_dots(size=dotSize) +
    tm_legend(legend.outside=legendPosition)
  return(plot)
}

sf_obsData.idw <- runInterpolation(sf_obsData, obsData$measurement, idwPower, samplePoints, sampleType)

raster_object       <- raster(sf_obsData.idw)
raster_object.mask  <- mask(raster_object, polygon)

idw <- plotInterpolationMap(raster_object.mask, sf_obsData, legendLabel)
idw

png(options$outputData)
idw
dev.off()