Merge pull request #50 from BalintKomjati/master

Fixing Issue #49

R/plot_3D.R

@@ -1,7 +1,10 @@
 #' Create 3D interactive elevation map from gpx tracklogs
 #'
-#' @param tracklog_file A path to a gpx file to be read by strava::process_data.
-#' If the file covers a big area plot_3D() can slow down significantly.
+#' @param tracklog_folder The path to the folder of your gpx file to be read by strava::process_data().
+#' process_data() will read all gpx files from this folder and plot_3D() will plot them all.
+#' It is however recommended to PLACE ONLY ONE GPX file within the folder.
+#' If the tracks cover an extended area plot_3D() can slow down significantly.
+#' If tracklog_folder is undefined plot_3D() loads an example tracklog provided with the package.
 #' @param cache_folder Directory to store the downloaded elevation data and overlay image for reuse
 #' @param elevation_scale Horizontal vs vertical ratio of the plot. Could be estimated with geoviz::raster_zscale(dem).
 #' @param elevation_scale_tracklog_corr Raises elevation_scale for the tracklog by the specified percentage.
@@ -25,7 +28,7 @@
 #' strava::plot_3D()
 #' }
 plot_3D <- function(
-                     tracklog_file = "gpx/mtb",
+                     tracklog_folder = NULL,
                      cache_folder = "~/cache_plot_3D",
                      elevation_scale = 6, #
                      elevation_scale_tracklog_corr = .01,
@@ -44,7 +47,12 @@ plot_3D <- function(
 
 
   message("Reading the tracklog")
-  tracklog <- strava::process_data(system.file(tracklog_file, package = "strava"))
+  if (is.null(tracklog_folder)) {
+    tracklog <- strava::process_data(system.file("gpx/mtb", package = "strava"))
+  } else {
+    tracklog <- strava::process_data(tracklog_folder)
+  }
+
 
 
   if( paste0(dem_file,".gri") %>% file.exists() ) {