plotly interactive stuff added to magimage

Author: asgr

DESCRIPTION

@@ -1,13 +1,13 @@
 Package: magicaxis
 Type: Package
 Title: Pretty Scientific Plotting with Minor-Tick and Log Minor-Tick Support
-Version: 2.5.1
-Date: 2025-08-04
+Version: 2.5.2
+Date: 2025-09-18
 Authors@R: person(given = "Aaron",
                       family = "Robotham",
                       role = c("aut", "cre"),
                       email = "aaron.robotham@uwa.edu.au")
 Description: Functions to make useful (and pretty) plots for scientific plotting. Additional plotting features are added for base plotting, with particular emphasis on making attractive log axis plots.
 License: GPL-3
-Suggests: imager, fst
+Suggests: imager, fst, plotly
 Imports: grDevices, graphics, stats, celestial (>= 1.4.1), MASS, plotrix, sm, mapproj, RANN

R/magbin.R

@@ -304,7 +304,7 @@
   }
 
   output = list(bins=data.frame(grid, count=bincount, zstat=binzstat), dust=dust, groups=groups,
-                xlim=xlim, ylim=ylim, step=step, dustlim=dustlim, shape=shape, direction=direction)
+                xlim=xlim, ylim=ylim, step=step, dustlim=dustlim, shape=shape, direction=direction, use=use)
   class(output) = 'magbin'
   return(output)
 }

R/magimage.R

@@ -2,7 +2,7 @@ magimage = function(x, y, z, zlim, xlim, ylim, col = grey((0:1e3)/1e3), add = FA
                    useRaster=TRUE, asp=1, magmap=TRUE, locut=0.4, hicut=0.995, flip=FALSE,
                    range=c(0,1), type = "quan", stretch="asinh", stretchscale='auto',
                    bad=NA, clip="", axes=TRUE, frame.plot=TRUE, sparse='auto', qdiff=FALSE,
-                   rem_med=FALSE, doplot=TRUE, ...){ 
+                   rem_med=FALSE, doplot=TRUE, interact=FALSE, ...){ 
   if(is.list(x)){
     if(!all(names(x) %in% c('x','y','z'))){
       message('x is a list (and not just x/y/z components), perhaps you want to pass a subset of this to magimage?')
@@ -108,6 +108,23 @@ magimage = function(x, y, z, zlim, xlim, ylim, col = grey((0:1e3)/1e3), add = FA
     }
   }
 
+  if(interact){
+    if(!requireNamespace("plotly", quietly = TRUE)){
+      stop('The plotly package is needed for this function to work. Please install it from CRAN.', call. = FALSE)
+    }
+    
+    fig = plotly::plot_ly(x=x, y=y, z=z, type = "heatmap", colors = col, transpose=TRUE)
+    
+    fig = plotly::layout(
+      p = fig,
+      xaxis = list(range = xlim, scaleanchor = "y"),  # Set x-axis limits and anchor to y-axis
+      yaxis = list(range = ylim)   # Set y-axis limits
+    )
+    
+    print(fig)
+    return(invisible(NULL))
+  }
+  
   if(!doplot){
     return(invisible(list(x=x, y=y, z=z)))
   }

R/magimageRGB.R

@@ -88,14 +88,26 @@ magimageRGB<-function(x, y, R, G, B, saturation=1, zlim, xlim, ylim, add = FALSE
     rm(Ba)
   }
 
-  # R=R-min(R)
-  # R=R/max(R)
-  # G=G-min(G)
-  # G=G/max(G)
-  # B=B-min(B)
-  # B=B/max(B)
+  z = matrix(1:length(R),dim(R)[1])
+  col = rgb(R,G,B)
 
-  do.call('image',c(list(x=x, y=y, z=matrix(1:length(R),dim(R)[1]), zlim=zlim, xlim=xlim, ylim=ylim, col=rgb(R,G,B), add=add, useRaster=useRaster, axes=FALSE, asp=asp, xlab='', ylab='', main=''), dotsimage))
+  # if(interact){
+  #   if(!requireNamespace("plotly", quietly = TRUE)){
+  #     stop('The plotly package is needed for this function to work. Please install it from CRAN.', call. = FALSE)
+  #   }
+  #   fig = plotly::plot_ly(x=x, y=y, z=z, type = "heatmap", colors = col, transpose=TRUE)
+  #   
+  #   fig = plotly::layout(
+  #     p = fig,
+  #     xaxis = list(range = xlim, scaleanchor = "y"),  # Set x-axis limits and anchor to y-axis
+  #     yaxis = list(range = ylim)   # Set y-axis limits
+  #   )
+  #   
+  #   print(fig)
+  #   return(invisible(NULL))
+  # }
+  
+  do.call('image',c(list(x=x, y=y, z=z, zlim=zlim, xlim=xlim, ylim=ylim, col=col, add=add, useRaster=useRaster, axes=FALSE, asp=asp, xlab='', ylab='', main=''), dotsimage))
   if(add==FALSE){
     if(axes){
       magaxis(...)

man/magimage.Rd

@@ -13,7 +13,7 @@ magimage(x, y, z, zlim, xlim, ylim, col = grey((0:1000)/1000), add = FALSE,
   useRaster = TRUE, asp = 1, magmap = TRUE, locut = 0.4, hicut = 0.995, flip = FALSE,
   range = c(0, 1), type = "quan", stretch = "asinh", stretchscale = 'auto', bad = NA,
   clip = "", axes = TRUE, frame.plot = TRUE, sparse = 'auto', qdiff = FALSE,
-  rem_med = FALSE, doplot = TRUE, ...)
+  rem_med = FALSE, doplot = TRUE, interact = FALSE, ...)
 
 magimageRGB(x, y, R, G, B, saturation = 1, zlim, xlim, ylim, add = FALSE,
   useRaster = TRUE, asp = 1, magmap = TRUE, locut = 0.4, hicut = 0.995, flip = FALSE,
@@ -105,6 +105,9 @@ Logical; should the \code{median} of the \option{image} be subtracted or not? Th
 }
   \item{doplot}{
 Logical; if TRUE then gnerates the image. If FALSE then just return the output below (with z scaled as request).  
+}
+  \item{interact}{
+Logical; if TRUE then an interactive \code{plotly} viewer will be displayed. You will need the \code{plotly} package from CRAN for this to work.
 }
   \item{\dots}{
 Arguments to be parsed to \code{image} and \code{magaxis} as relevant (this is checked for internally by argument name). See \code{\link{image}} and \code{\link{magaxis}} for details.