fix #19. parameter KeepReturns in metrics_echo2 now has a default val…

…ue of c(1,2,3,4)
ptompalski · Mar 16, 2024 · 20c3ce1 · 20c3ce1
1 parent 3104c2c
commit 20c3ce1
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/R/metrics_echo2.R b/R/metrics_echo2.R
@@ -10,7 +10,7 @@
 #' Allows to either limit the output to particular return numbers of interest (e.g. c(1, 3)), 
 #' or extend the output to always include the same return numbers (useful when processing multiple datasets with 
 #' different return numbers). See examples.
-#' Default NULL - all return numbers are included. 
+#' Default c(1,2,3,4) - return numbers 1 - 4 are included. 
 #' @inheritParams metrics_basic
 #' 
 #' @return A list. Number of points by each return number.
@@ -33,7 +33,7 @@
 
 
 
-metrics_echo2 <- function(ReturnNumber, KeepReturns=NULL, z=NULL, zmin=NA) {
+metrics_echo2 <- function(ReturnNumber, KeepReturns=c(1,2,3,4), z=NULL, zmin=NA) {
 
   #check user inputs
   if(!is.na(zmin))  assert_is_a_number(zmin)

diff --git a/man/metrics_echo2.Rd b/man/metrics_echo2.Rd