Merge pull request #28 from uclahs-cds/stefaneng-s3-print-26

Add print/plot S3 methods for VennDiagram

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: VennDiagram
-Version: 1.7.6
+Version: 1.8.0
 Type: Package
 Title: Generate High-Resolution Venn and Euler Plots
 Date: 2023-08-23

NAMESPACE

@@ -31,3 +31,5 @@ importFrom("methods", "is")
 import(grid,
       futile.logger
 )
+S3method(print, VennDiagram)
+S3method(plot, VennDiagram)

NEWS

@@ -1,7 +1,8 @@
-VennDiagram 1.7.6 2023-08-23 (Dan Knight)
+VennDiagram 1.8.0 2023-08-23 (Stefan Eng, Dan Knight)
 ---------------------------------------------------------------------------------------------------
-MINOR UPDATE
-* Update CICD-base workflow
+MINOR UPDATES
+* Implemented S3 print/plot methods for VennDiagram class
+* Update CICD workflows
 
 VennDiagram 1.7.5 2023-02-28 (Stefan Eng)
 ---------------------------------------------------------------------------------------------------

R/draw.pairwise.venn.R

@@ -1214,5 +1214,6 @@ stop('Invalid value for "cat.default.pos", should be either "outer" or "text"');
 	grob.list <- adjust.venn(rotate.venn.degrees(grob.list, rotation.degree, rotation.centre[1], rotation.centre[2]), ...);
 	# draw the plot before returning the grob if specified
 	if (ind) { grid.draw(grob.list); }
+	class(grob.list) <- c('VennDiagram', class(grob.list));
 	return(grob.list);
 	}

R/draw.quad.venn.R

@@ -356,5 +356,6 @@ stop(paste0('Unknown value passed to cex.prop: ', cex.prop))
 
 	# draw diagram before returning gList is specified by user
 	if (ind) { grid.draw(grob.list); }
+	class(grob.list) <- c('VennDiagram', class(grob.list));
 	return(grob.list);
 	}

R/draw.quintuple.venn.R

@@ -448,5 +448,6 @@ stop(paste0('Unknown value passed to cex.prop: ', cex.prop))
 	# adjust grob.list to fit and return grob.list
 	grob.list <- VennDiagram::adjust.venn(VennDiagram::rotate.venn.degrees(grob.list, rotation.degree, rotation.centre[1], rotation.centre[2]), ...);
 	if (ind) { grid.draw(grob.list); }
+	class(grob.list) <- c('VennDiagram', class(grob.list));
 	return(grob.list);
 	}

R/draw.single.venn.R

@@ -157,5 +157,6 @@ stop('Unexpected parameter format for "cat.just"'); }
 	grob.list <- gList(grob.list, tmp);
 	grob.list <- VennDiagram::adjust.venn(VennDiagram::rotate.venn.degrees(grob.list, rotation.degree, rotation.centre[1], rotation.centre[2]), ...);
 	if (ind) { grid.draw(grob.list); }
+	class(grob.list) <- c('VennDiagram', class(grob.list));
 	return(grob.list);
 	}

R/draw.sp.case.R

@@ -176,6 +176,7 @@ stop('Invalid cat.default.pos setting');
 		if (reverse) {
 			return(VennDiagram::flip.venn(grob.list, axis = 'v'));
 			}
-		}
+	}
+	class(grob.list) <- c('VennDiagram', class(grob.list));
 	return(grob.list);
 	}

R/draw.triple.venn.R

@@ -590,5 +590,6 @@ stop('Invalid setting of cat.default.pos');
 
 	# draw diagram before returning gList is specified by user
 	if (ind) { grid.draw(grob.list); }
+	class(grob.list) <- c('VennDiagram', class(grob.list));
 	return(grob.list);
 	}

R/venn.diagram.R

@@ -9,6 +9,26 @@
 # If publications result from research using this SOFTWARE, we ask that the Ontario Institute for Cancer Research be acknowledged and/or
 # credit be given to OICR scientists, as scientifically appropriate.
 
+print.VennDiagram <- plot.VennDiagram <- function(x, newpage = is.null(vp), vp = NULL, ...) {
+	if (newpage) 
+		grid.newpage();
+	grDevices::recordGraphics(
+		expr = requireNamespace("VennDiagram", quietly = TRUE), 
+		list = list(),
+		env = getNamespace("VennDiagram")
+		);
+	if (is.null(vp)) {
+		grid.draw(x);
+	} else {
+		if (is.character(vp)) 
+			seekViewport(vp)
+		else pushViewport(vp);
+		grid.draw(x);
+		upViewport();
+		}
+	invisible(x);
+	}
+
 ### UMBRELLA FUNCTION TO DRAW VENN DIAGRAMS #######################################################
 venn.diagram <- function(
 	x,
@@ -501,7 +521,10 @@ stop('You have misspelled your "imagetype", please try again');
 		# return a success code
 		return(1);
 		}
-
+
+	if (! 'VennDiagram' %in% class(grob.list)) {
+		class(grob.list) <- c('VennDiagram', class(grob.list));
+		}
 	# if file creation was not requested return the plotting object
 	return(grob.list);
 	}