From 20c3ce1838a35f024536169fb1cf4421045a4584 Mon Sep 17 00:00:00 2001 From: Tompalski Date: Fri, 15 Mar 2024 18:38:44 -0700 Subject: [PATCH] fix #19. parameter KeepReturns in metrics_echo2 now has a default value of c(1,2,3,4) --- R/metrics_echo2.R | 4 ++-- man/metrics_echo2.Rd | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/R/metrics_echo2.R b/R/metrics_echo2.R index c13f2d9..50e0a61 100644 --- 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 index 2754f7d..606c444 100644 --- a/man/metrics_echo2.Rd +++ b/man/metrics_echo2.Rd @@ -9,7 +9,7 @@ An object of class \code{formula} of length 2. } \usage{ -metrics_echo2(ReturnNumber, KeepReturns = NULL, z = NULL, zmin = NA) +metrics_echo2(ReturnNumber, KeepReturns = c(1, 2, 3, 4), z = NULL, zmin = NA) .metrics_echo2 } @@ -20,7 +20,7 @@ metrics_echo2(ReturnNumber, KeepReturns = NULL, z = NULL, zmin = NA) 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.} \item{z}{Z coordinate of the point cloud (point heights)}