new text argument in plotFun.stn

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: plotFun
 Type: Package
 Title: Helper functions for plotting data
-Version: 1.0.2
-Date: 2019-01-15
+Version: 1.0.3
+Date: 2019-03-19
 Author: A. Casanueva
 Maintainer: A.Casanueva <ana.casanueva@meteoswiss.ch>
 Description: Helper functions for plotting data.

NEWS

@@ -1,3 +1,7 @@
+* Changes in v1.0.3
+
+Allow plotFun.stn to plot text on markers place.
+
 * Changes in v1.0.2
 
 Change function names to avoid S3 methods.

R/plotFun.stn.R

@@ -23,6 +23,8 @@
 #' @param cex.unit numeric value giving the expansion factor of the units text. Default:1.
 #' @param width.cbar numeric value giving the fraction of the plot (from 0 to 1) reserved for the colorbar. Modify this argument for a better appearance. Default=0.1
 #' @param axis.lab display or not lon/lat ticks and labels. Default=FALSE
+#' @param text display some text in each point. Length should be the same as lat and lon.
+#' @param cex.cex numeric value giving the text expansion factor. Default: 1.
 #' @param disp.warnings logical to set if warnings shoul be displayed.
 #' @param export logical. If TRUE, the figure is exported as pdf file. Default: False.
 #' @param export.path path (including file name) to save the plot.
@@ -47,7 +49,12 @@
 #' unit.text = "degC")
 #' }
 
-plotFun.stn <- function(data, lon, lat, xlims, ylims, lattice=NULL, breaks= NULL, palette=rainbow(10), window.width=8, window.height=6,  title.main=NULL, title.single=NULL,  unit.text=NULL, mark.border=TRUE, cex.marker=1, cex.main=1,  cex.single=1, cex.unit=1, cex.textcbar=1, width.cbar=0.1, disp.warnings=FALSE, axis.lab=FALSE, export=FALSE, export.format=NULL, export.path=NULL){
+plotFun.stn <- function(data, lon, lat, xlims, ylims, lattice=NULL, breaks= NULL, 
+                        palette=rainbow(10), window.width=8, window.height=6,  title.main=NULL, 
+                        title.single=NULL,  unit.text=NULL, mark.border=TRUE, cex.marker=1, 
+                        cex.main=1,  cex.single=1, cex.unit=1, cex.textcbar=1, width.cbar=0.1, 
+                        disp.warnings=FALSE, axis.lab=FALSE, export=FALSE, export.format=NULL, 
+                        export.path=NULL, text=NULL, cex.text=1){
 
 	# Verification checks 
 	try(if(export & is.null(export.format)) stop("Cannot save plot: missing export.format"))
@@ -71,7 +78,7 @@ plotFun.stn <- function(data, lon, lat, xlims, ylims, lattice=NULL, breaks= NULL
 		if(is.null(breaks)) breaks <- set.Breaks(data)
 
 		# Plot
-		plotFun.stn1(data, lon, lat, xlims, ylims, breaks, palette, cex.marker, cex.main, title.main, axis.lab, mark.border=mark.border)
+		plotFun.stn1(data, lon, lat, xlims, ylims, breaks, palette, cex.marker, cex.main, title.main, axis.lab, mark.border=mark.border, text=text, cex.text=cex.text)
 
 		# Include colorbar
 		par(mar=c(3,0.6,3,5))
@@ -110,7 +117,7 @@ plotFun.stn <- function(data, lon, lat, xlims, ylims, lattice=NULL, breaks= NULL
 
 		# Plot subplots
 		for (i in 1:nrow(data)){
-			plotFun.stn1(data[i,], lon, lat, xlims, ylims, breaks, palette, cex.marker, cex.single, title.single[i], axis.lab, mark.border=mark.border)
+			plotFun.stn1(data[i,], lon, lat, xlims, ylims, breaks, palette, cex.marker, cex.single, title.single[i], axis.lab, mark.border=mark.border, text=text, cex.text=cex.text)
 		}
 
 		# Fill with empty plots when necessary (i.e. to fill the matrix)

R/plotFun.stn1.R

@@ -14,11 +14,15 @@
 #' @param cex.main numeric value giving the title expansion factor. Default: 1.
 #' @param mark.border logical. If black contour for the cicles is plotted. Default=TRUE.
 #' @param axis.lab display or not lon/lat ticks and labels. Default=FALSE
+#' @param text display some text in each point. Length should be the same as lat and lon.
+#' @param cex.cex numeric value giving the text expansion factor. Default: 1.
 #'
 #' @author Ana Casanueva (16.02.2017)
 #' 
 
-plotFun.stn1 <- function(x, lon, lat, xlims, ylims, breaks= breaks, palette=palette, cex.marker, cex.main, title.main, axis.lab, mark.border=mark.border) {
+plotFun.stn1 <- function(x, lon, lat, xlims, ylims, breaks= breaks, palette=palette, cex.marker, 
+                         cex.main, title.main, axis.lab, mark.border=mark.border,
+                         text=NULL, cex.text=1) {
 
   if(length(lon)== length(x) & length(lat)== length(x) & length(lon)== length(lat)){
 
@@ -48,7 +52,11 @@ plotFun.stn1 <- function(x, lon, lat, xlims, ylims, breaks= breaks, palette=pale
       points(lon,lat, cex=cex.marker, pch=16, col=colcode)
     }
     #
-
+    if(!is.null(text)){
+      if(length(text)==length(lon)){
+       text(lon, lat, labels=text, cex=cex.text) 
+      } else stop("Text length does not match the number of points.") 
+    }
     title(main= title.main, cex.main=cex.main, line=0)
   } else stop("Number of stations does not match the data size")