add vdat_template

Author: mhpob

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: rvdat
 Title: Lightweight access to VDAT shell commands
-Version: 0.0.0.9005
+Version: 0.0.0.9100
 Authors@R: c(
     person("Michael", "O'Brien", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-1420-6395"))

NAMESPACE

@@ -5,6 +5,7 @@ export(skip_example_on_runiverse)
 export(vdat_call)
 export(vdat_here)
 export(vdat_inspect)
+export(vdat_template)
 export(vdat_to_csv)
 export(vdat_to_folder)
 export(vdat_to_json)

R/vdat_template.R

@@ -0,0 +1,40 @@
+#' Return description fields ("template") of different VDAT data types and/or files
+#'
+#' @param format file format of the template. Currently only accepts "csv.fathom";
+#'      here for future compatibility.
+#' @param print logical. Defaults to FALS.E Print the output to console?
+#' @param ... arguments passed to [`vdat_call`].
+#'
+#' @export
+
+vdat_template <- function(
+    format = 'csv.fathom',
+    print = FALSE,
+    ...
+){
+
+  format <- match.arg(format, 'csv.fathom')
+
+  shell_out <- vdat_call(
+    what = c(
+      "template",
+      paste0('--format=', format)
+    ),
+    pass_error = TRUE,
+    print = print,
+    ...
+  )
+
+  template <- rawToChar(shell_out$stdout)
+  template <- unlist(
+    strsplit(
+      template,
+      '\r\n'
+    )
+  )
+  template <- strsplit(template, ',')[-c(1:2)]
+
+  names(template) <- sapply(template, `[`, 1)
+
+  lapply(template, `[`, -1)
+}

README.Rmd

@@ -74,9 +74,6 @@ remotes::install_github("mhpob/rvdat")
 
 -   [ ] Sensor values
 -   [ ] Logging
--   Create template for
-    -   [ ] CSV
-    -   [ ] JSON
 -   [ ] Look for `vdat.exe`
 
 ### Completed
@@ -89,6 +86,7 @@ remotes::install_github("mhpob/rvdat")
 -   [X] Output location
 -   [X] Time correction
 -   [X] Inspect content of file
+-   [X] Create CSV template
 
 ### Won't add (for now)
 
@@ -98,6 +96,9 @@ remotes::install_github("mhpob/rvdat")
     -   Removed from `vdat.exe` in spring 2023. Left to user.
 -   [ ] ~~Time offset~~
     -   Won't add; subtracts a number of hours from the time without being DST-aware.
+-   [ ] ~~JSON template~~
+    -   The `json.rxlog` and `vfwp` formats noted in the help documentation return
+        as invalid.
 
 
 ## Using the package

README.md

@@ -88,9 +88,6 @@ remotes::install_github("mhpob/rvdat")
 
 - [ ] Sensor values
 - [ ] Logging
-- Create template for
-  - [ ] CSV
-  - [ ] JSON
 - [ ] Look for `vdat.exe`
 
 ### Completed
@@ -103,6 +100,7 @@ remotes::install_github("mhpob/rvdat")
 - [x] Output location
 - [x] Time correction
 - [x] Inspect content of file
+- [x] Create CSV template
 
 ### Won’t add (for now)
 
@@ -114,6 +112,9 @@ remotes::install_github("mhpob/rvdat")
 - [ ] ~~Time offset~~
   - Won’t add; subtracts a number of hours from the time without being
     DST-aware.
+- [ ] ~~JSON template~~
+  - The `json.rxlog` and `vfwp` formats noted in the help documentation
+    return as invalid.
 
 ## Using the package
 
@@ -142,10 +143,10 @@ Convert a VRL to CSV:
 ``` r
 ## vdat_to_csv("SOME-VDAT-FILE")
 #> ✔ File converted:
-#>   C:\Users\darpa2\AppData\Local\Temp\RtmpQnIw42/readme_files/HR2-180 461396
+#>   C:\Users\darpa2\AppData\Local\Temp\RtmpIdz6ds/readme_files/HR2-180 461396
 #>   2021-04-20 173145.vdat
 #> ℹ File saved in:
-#>   C:\Users\darpa2\AppData\Local\Temp\RtmpQnIw42/readme_files/HR2-180 461396
+#>   C:\Users\darpa2\AppData\Local\Temp\RtmpIdz6ds/readme_files/HR2-180 461396
 #>   2021-04-20 173145.csv
 ```
 
@@ -154,10 +155,10 @@ Convert a VRL to a folder of CSVs split by data type:
 ``` r
 ## vdat_to_folder("SOME-VDAT-FILE")
 #> ✔ File converted:
-#>   C:\Users\darpa2\AppData\Local\Temp\RtmpQnIw42/readme_files/HR2-180 461396
+#>   C:\Users\darpa2\AppData\Local\Temp\RtmpIdz6ds/readme_files/HR2-180 461396
 #>   2021-04-20 173145.vdat
 #> ℹ Files saved in:
-#>   C:\Users\darpa2\AppData\Local\Temp\RtmpQnIw42/readme_files/HR2-180 461396
+#>   C:\Users\darpa2\AppData\Local\Temp\RtmpIdz6ds/readme_files/HR2-180 461396
 #>   2021-04-20 173145.csv-fathom-split
 ## list.files("SOME-VDAT-FILE.csv-fathom-split")
 #>  [1] "ATTITUDE.csv"         "BATTERY.csv"          "CFG_CHANNEL.csv"     

man/vdat_template.Rd

@@ -0,0 +1,42 @@
+test_that("error if not csv", {
+  expect_error(
+    vdat_template(format = 'json'),
+    '\'arg\' should be "csv.fathom"'
+  )
+})
+
+test_that("partial matching works", {
+  expect_equal(
+    vdat_template(),
+    vdat_template(format = 'csv')
+  )
+})
+
+test_that("print works", {
+  expect_output(
+    vdat_template(print = TRUE)
+  )
+})
+
+test_that("correct types", {
+  template <- vdat_template()
+
+  expect_type(template, 'list')
+
+  expect_length(template, 45)
+  expect_named(
+    template,
+    c("ATTITUDE_DESC", "BATTERY_DESC", "CFG_CHANNEL_DESC", "CFG_RECEIVER_HR3_DESC",
+      "CFG_STATION_DESC", "CFG_STUDY_DESC", "CFG_TRANSMITTER_DESC", "CLOCK_REF_DESC",
+      "CLOCK_SET_DESC", "DATA_ERROR_DESC", "DATA_SOURCE_FILE_DESC", "DEPTH_DESC",
+      "DEPTH_STATS_DESC", "DET_DESC", "DET_HTI_DESC", "DET_FILTER_DESC",
+      "DET_SENS_DESC", "DIAG_DESC", "DIAG_FAST_DESC", "DIAG_HR2_DESC",
+      "DIAG_HR3_DESC", "DIAG_VR2W_DESC", "DIAG_VR2W_INTERIM_DESC", "DIAG_VR2AR_DESC",
+      "DIAG_VR2AR_INTERIM_DESC", "DIAG_VR2TX_DESC", "DIAG_VR2TX_INTERIM_DESC",
+      "DIAG_VR4_DESC", "EVENT_DESC", "EVENT_FAULT_DESC", "EVENT_INIT_DESC",
+      "EVENT_OFFLOAD_DESC", "HEALTH_HR2_DESC", "HEALTH_HR3_DESC", "HEALTH_VR2AR_DESC",
+      "HEALTH_VR2TX_DESC", "HEALTH_VR2W_DESC", "HEALTH_VR4_DESC", "NOISE_DESC",
+      "NOISE_STATS_VR2AR_DESC", "NOISE_STATS_VR2TX_DESC", "PING_DESC", "TEMP_DESC",
+      "TEMP_STATS_DESC", "XPND_EVENT_DESC")
+  )
+})