detection_range_model function

.gitignore

@@ -9,3 +9,4 @@ doc
 *Icon*
 /doc/
 /Meta/
+inst/doc

DESCRIPTION

@@ -1,51 +1,55 @@
-Package: glatos
-Type: Package
-Title: A package for the Great Lakes Acoustic Telemetry Observation System
-Description: Functions useful to members of the Great Lakes Acoustic Telemetry Observation System https://glatos.glos.us; many more broadly relevant to simulating, processing, analysing, and visualizing acoustic telemetry data.
-Version: 0.8.0
-Date: 2024-09-18
-Depends: R (>= 3.6.0)
-Imports:
-		av,
-		data.table,
-		dplyr,
-		geodist,
-		gdistance,
-		jsonlite,
-		lubridate,
-		plotrix,
-		raster,
-		readxl,
-		sf,
-		sp,
-		zip
-Suggests: 
-    vdiffr,
-		gifski,
-		knitr,
-		methods,
-		png,
-		rmarkdown,
-		terra,
-		testthat (>= 3.0.0),
-		tint
-URL: https://github.com/ocean-tracking-network/glatos
-BugReports: https://github.com/ocean-tracking-network/glatos/issues
-Authors@R: c(
-    person("Christopher", "Holbrook", email = "[email protected]",
-			role = c("cre", "aut")),
-    person("Todd", "Hayden", role = "aut"),
-		person("Thomas", "Binder", role = "aut"),
-		person("Jon", "Pye", role = "aut"),
-		person("Mike", "O'Brien", role = "ctb"),
-		person("Alex", "Nunes", role = "ctb"),
-		person("Angela", "Dini", role = "ctb"),
-		person("Ryan", "Gosse", role = "ctb"))
-License: GPL-2
-LazyLoad: yes
-LazyData: true
-RoxygenNote: 7.3.2
-VignetteBuilder: knitr
-Encoding: UTF-8
-Roxygen: list(markdown = TRUE)
-Config/testthat/edition: 3
+Package: glatos
+Type: Package
+Title: A package for the Great Lakes Acoustic Telemetry Observation System
+Description: Functions useful to members of the Great Lakes Acoustic Telemetry Observation System https://glatos.glos.us; many more broadly relevant to simulating, processing, analysing, and visualizing acoustic telemetry data.
+Version: 0.8.0
+Date: 2024-09-19
+Depends: R (>= 3.6.0)
+Imports:
+		av,
+		data.table,
+		dplyr,
+		geodist,
+		gdistance,
+		jsonlite,
+		lubridate,
+		plotrix,
+		raster,
+		readxl,
+		sf,
+		sp,
+		zip
+Suggests: 
+    vdiffr,
+    ggplot2,
+		gifski,
+		knitr,
+		mapview,
+		methods,
+		png,
+		purrr,
+		rmarkdown,
+		terra,
+		testthat (>= 3.0.0),
+		tint
+URL: https://github.com/ocean-tracking-network/glatos
+BugReports: https://github.com/ocean-tracking-network/glatos/issues
+Authors@R: c(
+    person("Christopher", "Holbrook", email = "[email protected]",
+			role = c("cre", "aut")),
+    person("Todd", "Hayden", role = "aut"),
+		person("Thomas", "Binder", role = "aut"),
+		person("Jon", "Pye", role = "aut"),
+		person("Mike", "O'Brien", role = "ctb"),
+		person("Alex", "Nunes", role = "ctb"),
+		person("Benjamin", "Hlina", role = "ctb"),
+		person("Angela", "Dini", role = "ctb"),
+		person("Ryan", "Gosse", role = "ctb"))
+License: GPL-2
+LazyLoad: yes
+LazyData: true
+RoxygenNote: 7.3.2
+VignetteBuilder: knitr
+Encoding: UTF-8
+Roxygen: list(markdown = TRUE)
+Config/testthat/edition: 3

NAMESPACE

@@ -19,6 +19,7 @@ export(crw_in_polygon)
 export(detect_transmissions)
 export(detection_bubble_plot)
 export(detection_events)
+export(detection_range_model)
 export(false_detections)
 export(format_POSIXt)
 export(get_local_vdat_template)

NEWS.md

@@ -1,6 +1,6 @@
 ----
 
-# glatos 0.8.9011 (2024-09-18)
+# glatos 0.8.0 (2024-09-19)
 
 
 ## Breaking changes
@@ -81,7 +81,7 @@ from earlier versions.
     - fixes [issue #126](https://github.com/ocean-tracking-network/glatos/issues/126)
     - fixes [issue #78](https://github.com/ocean-tracking-network/glatos/issues/78)
 
-- New function `jarasterize()` to allow rasterization 
+- Add new function `jarasterize()` to allow rasterization 
   (esp. with `all_touched = TRUE`) using only `sf` and `raster`. 
   Used by `make_transition()`.
 
@@ -91,6 +91,10 @@ from earlier versions.
 - In `make_frames()`, allow `terra::SpatVector` input for background map 
   (`bg_map` arg).
     - add test for `terra::SpatVector` input
+
+- Add new function `detection_range_model()` for estimating detection range at 
+  which a certain detection efficiency is expected, using output from 
+  Innovasea's range testing software.
 
 
 ### Bug fixes and minor changes
@@ -712,4 +716,3 @@ with previous.
 #### 2017-03-01
 
 ### - initial release on OTN gitlab
-

R/data.r

@@ -119,7 +119,6 @@
 #'
 "range_detection"
 
-
 #' A schema for Innovasea Fathom (VDAT) CSV files
 #'
 #' A schema for Innovasea Fathom (VDAT) CSV files, produced by 'vdat.exe'
@@ -137,3 +136,26 @@
 #' @author C. Holbrook
 #'
 "vdat_csv_schema"
+
+#' Detection Efficiency data set
+#'
+#' Sample detection efficiency data set from Lake Papineau, Quebec, Canada.
+#'
+#' @details Data is from a preliminary range test, where tags were deployed at
+#' set distances away from a VR2W receiver for 24 hours. Once downloaded the vrl
+#' files were used in Vemco's Range Testing Software to produced this dataset.
+#'
+#' @format A data frame with 7 rows and 5 variables
+#' \describe{
+#'   \item{distance_m}{distance away from the receiver in meters}
+#'   \item{avg_percent}{average detection efficiency}
+#'   \item{std_dev}{standard deviation of detection efficiency}
+#'   \item{avg_percent_d}{average detection efficiency in decimal form needs
+#'   to be created by dividing \code{avg_percent} by 100}
+#'   \item{intercept}{y-intercept used for third order polynomial, set at 100.
+#'   Needs to be added to the original dataframe}
+#'   }
+#'
+#' @source B.L. Hlina
+#'
+"sample_detection_efficiency"