Simple 3d trajectory plot (line only - no ribbon)

Author: Max Czapanskiy

NAMESPACE

@@ -2,5 +2,6 @@
 
 export(read_nc)
 export(view_cats)
+export(view_cats_3d)
 import(dplyr)
 import(ggplot2)

R/viz.R

@@ -54,3 +54,18 @@ make_subplot <- function(var, prh) {
             legend.title = element_blank())) %>%
     plotly::ggplotly(dynamicTicks = TRUE)
 }
+
+#' Visualize CATS data as 3d geotrack
+#'
+#' @param prh A CATS PRH object (see \code{\link{read_nc}})
+#'
+#' @return A 3d plotly figure
+#' @export
+#'
+#' @examples
+#' view_cats_3d(mn200312_58)
+view_cats_3d <- function(prh) {
+  prh$z <- -prh$z
+  plotly::plot_ly(prh, x = ~x, y = ~y, z = ~z,
+                  type = "scatter3d", mode = "lines")
+}

README.Rmd

@@ -34,15 +34,17 @@ devtools::install_github("FlukeAndFeather/catsr")
 
 ## Reading data
 
-Read a CATS PRH file in NetCDF format.
+Read a CATS PRH file in NetCDF format. The .nc file for deployment mn200312-58 is included in the package.
 
 ```{r read}
 library(catsr)
 nc_path <- system.file("extdata", "mn200312-58_prh10.nc", package = "catsr")
-mn200312_58 <- read_nc(nc_path)
+mn200312_58_from_nc <- read_nc(nc_path)
 ```
 
-Examine PRH variables (e.g. depth, pitch, and roll) in an interactive plot. GitHub READMEs don't support interaction, so a screenshot is supplied instead.
+## Visualizing data
+
+Examine PRH variables (e.g. depth, pitch, and roll) in an interactive plot. This package also provides deployment mn200312-58 directly for use in R (`mn200312_58`). GitHub READMEs don't support interaction, so we show a screenshot here instead.
 
 ```{r plot}
 view_cats(mn200312_58, c("p", "pitch", "roll"))
@@ -54,3 +56,8 @@ Triaxial variables (such as accelerometry - `aw`) are represented in multiple co
 view_cats(mn200312_58, c("p", "aw", "mw"))
 ```
 
+Explore the animal's 3d movement trajectory.
+
+```{r plot_3d}
+view_cats_3d(mn200312_58)
+```

README.md

@@ -24,17 +24,21 @@ devtools::install_github("FlukeAndFeather/catsr")
 
 ## Reading data
 
-Read a CATS PRH file in NetCDF format.
+Read a CATS PRH file in NetCDF format. The .nc file for deployment
+mn200312-58 is included in the package.
 
 ``` r
 library(catsr)
 nc_path <- system.file("extdata", "mn200312-58_prh10.nc", package = "catsr")
-mn200312_58 <- read_nc(nc_path)
+mn200312_58_from_nc <- read_nc(nc_path)
 ```
 
+## Visualizing data
+
 Examine PRH variables (e.g. depth, pitch, and roll) in an interactive
-plot. GitHub READMEs don’t support interaction, so a screenshot is
-supplied instead.
+plot. This package also provides deployment mn200312-58 directly for use
+in R (`mn200312_58`). GitHub READMEs don’t support interaction, so we
+show a screenshot here instead.
 
 ``` r
 view_cats(mn200312_58, c("p", "pitch", "roll"))
@@ -50,3 +54,11 @@ view_cats(mn200312_58, c("p", "aw", "mw"))
 ```
 
 <img src="man/figures/README-plot_triax-1.png" width="100%" />
+
+Explore the animal’s 3d movement trajectory.
+
+``` r
+view_cats_3d(mn200312_58)
+```
+
+<img src="man/figures/README-plot_3d-1.png" width="100%" />