Add camera scene

KatrionaGoldmann · Mar 26, 2021 · 3b43ed7 · 3b43ed7
1 parent d024702
commit 3b43ed7
Show file tree

Hide file tree

Showing 37 changed files with 99 additions and 50 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -2,7 +2,7 @@ Package: volcano3D
 Type: Package
 Title: Interactive Plotting of Three-Way Differential Expression
         Analysis
-Version: 1.1.0
+Version: 1.2.0
 Authors@R: c(person("Katriona", "Goldmann", role = c("aut", "cre"),
                        email = "k.goldmann@qmul.ac.uk",
                        comment = c(ORCID = "0000-0002-9073-6323")),

diff --git a/NEWS.md b/NEWS.md
@@ -1,6 +1,10 @@
 News
 =====
 
+# volcano3D 1.2.0
+###### 25/02/2021
+* Add argument for scene camera in volcano3D
+
 # volcano3D 1.1.0
 ###### 04/02/2021
 * allow colour coding to be based on pvalue or adjusted pvalue according to cutoff_criteria

diff --git a/R/volcano3D.R b/R/volcano3D.R
@@ -54,6 +54,12 @@
 #' @param xy_aspectratio The aspect ratio for the xy axis compared to z
 #' (default = 1). Decreasing this makes the grid wider in the plot window. 
 #' @param plot_height The plot height in px. Default=700. 
+#' @param camera_eye The (x,y,z) components of the 'eye' camera vector. This 
+#' vector determines the view point about the origin of this scene.
+#' @param source a character string of length 1. Match the value of this string 
+#' with the source argument in \code{\link[plotly]{event_data}} to retrieve the 
+#' event data corresponding to a specific plot (shiny apps can have multiple 
+#' plots).
 #' @param ... Optional parameters to pass to \code{\link{polar_grid}}.
 #' @return Returns a cylindrical 3D plotly plot featuring variables on a 
 #' tri-axis radial graph with the -log10(multi-group test p-value) on the 
@@ -115,6 +121,8 @@ volcano3D <- function(polar,
                       z_aspectratio = 1, 
                       xy_aspectratio = 1,
                       plot_height = 700,
+                      camera_eye = list(x=1.25, y=1.25, z=1.25),
+                      source="volcano3D",
                       ...){
 
     if(! class(polar) %in% c("polar")) stop("polar must be a polar object")
@@ -286,7 +294,7 @@ volcano3D <- function(polar,
             colors = switch(colour_scale,
                             "discrete" = colours,
                             "continuous" = NULL),
-            type = "scatter3d", mode = "markers") %>%
+            type = "scatter3d", mode = "markers", source = source) %>%
 
         # Add the cylindrical grid
         add_trace(x = polar_grid$x, y = polar_grid$y, z = polar_grid$z, 
@@ -335,14 +343,16 @@ volcano3D <- function(polar,
         plot_bgcolor = 'rgba(0, 0, 0, 0)',
 
         scene = list(
-            aspectratio = list(x = xy_aspectratio, 
-                               y = xy_aspectratio, 
+            camera = list(eye = camera_eye),
+            aspectratio = list(x = xy_aspectratio,
+                               y = xy_aspectratio,
                                z = z_aspectratio),
             dragmode = "turntable",
             xaxis = axis_settings_xy,
             yaxis = axis_settings_xy,
             zaxis = axis_settings,
-            annotations = annot),
+            annotations = annot
+            ),
         xaxis = list(title = "x"),
         yaxis = list(title = "y")
     )

diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/ReadMe.html b/docs/ReadMe.html
diff --git a/docs/articles/Extended_Vignette.html b/docs/articles/Extended_Vignette.html
diff --git a/docs/articles/Extended_Vignette_files/figure-html/unnamed-chunk-15-1.png b/docs/articles/Extended_Vignette_files/figure-html/unnamed-chunk-15-1.png
diff --git a/docs/articles/Extended_Vignette_files/figure-html/unnamed-chunk-16-1.png b/docs/articles/Extended_Vignette_files/figure-html/unnamed-chunk-16-1.png
diff --git a/docs/articles/Extended_Vignette_files/figure-html/unnamed-chunk-17-1.png b/docs/articles/Extended_Vignette_files/figure-html/unnamed-chunk-17-1.png
diff --git a/docs/articles/Extended_Vignette_files/figure-html/unnamed-chunk-18-1.png b/docs/articles/Extended_Vignette_files/figure-html/unnamed-chunk-18-1.png
diff --git a/docs/articles/Vignette.html b/docs/articles/Vignette.html
diff --git a/docs/articles/Vignette_files/figure-html/unnamed-chunk-13-1.png b/docs/articles/Vignette_files/figure-html/unnamed-chunk-13-1.png
diff --git a/docs/articles/index.html b/docs/articles/index.html
diff --git a/docs/articles/pvalues_generator.html b/docs/articles/pvalues_generator.html
diff --git a/docs/articles/shiny_builder.html b/docs/articles/shiny_builder.html
diff --git a/docs/articles/shiny_builder_files/figure-html/unnamed-chunk-7-1.png b/docs/articles/shiny_builder_files/figure-html/unnamed-chunk-7-1.png
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -1,10 +1,10 @@
-pandoc: '2.11'
+pandoc: 2.11.4
 pkgdown: 1.6.1
 pkgdown_sha: ~
 articles:
   Extended_Vignette: Extended_Vignette.html
   Vignette: Vignette.html
   pvalues_generator: pvalues_generator.html
   shiny_builder: shiny_builder.html
-last_built: 2021-03-04T14:40Z
+last_built: 2021-03-25T13:04Z
 
diff --git a/docs/reference/boxplot_trio.html b/docs/reference/boxplot_trio.html
diff --git a/docs/reference/grid-class.html b/docs/reference/grid-class.html
diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/polar-class.html b/docs/reference/polar-class.html
diff --git a/docs/reference/polar_coords.html b/docs/reference/polar_coords.html
diff --git a/docs/reference/polar_grid.html b/docs/reference/polar_grid.html
diff --git a/docs/reference/radial_ggplot.html b/docs/reference/radial_ggplot.html
diff --git a/docs/reference/radial_plotly.html b/docs/reference/radial_plotly.html
diff --git a/docs/reference/show_grid.html b/docs/reference/show_grid.html
diff --git a/docs/reference/significance_subset.html b/docs/reference/significance_subset.html
diff --git a/docs/reference/syn_example_meta.html b/docs/reference/syn_example_meta.html
diff --git a/docs/reference/syn_example_p.html b/docs/reference/syn_example_p.html
diff --git a/docs/reference/syn_example_rld.html b/docs/reference/syn_example_rld.html
diff --git a/docs/reference/volcano3D.html b/docs/reference/volcano3D.html
diff --git a/docs/reference/volcano_plot.html b/docs/reference/volcano_plot.html
diff --git a/docs/reference/volcano_trio.html b/docs/reference/volcano_trio.html