Skip to content

Commit d96a670

Browse files
mhpobmhpob
committed
update to vdat version 9.13.2
1 parent 98d7034 commit d96a670

8 files changed

+3754
-3812
lines changed

‎DESCRIPTION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: rvdat
22
Title: Lightweight Access to 'VDAT' Shell Commands
3-
Version: 0.0.0.9100
3+
Version: 0.0.1.900
44
Authors@R: c(
55
person("Michael", "O'Brien", , "[email protected]", role = c("aut", "cre"),
66
comment = c(ORCID = "0000-0003-1420-6395"))

‎README.Rmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
output: github_document
33
---
44

5-
<!-- README.md is generated from README.Rmd. Please edit that file -->
5+
<!-- README.md is generated from README.Rmd. Please edit that file -->
66

77
```{r, include = FALSE}
88
knitr::opts_chunk$set(

‎README.md

+27-90
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
<!-- README.md is generated from README.Rmd. Please edit that file -->
2+
<!-- README.md is generated from README.Rmd. Please edit that file -->
33

44
# rvdat
55

@@ -136,18 +136,18 @@ What version?
136136

137137
``` r
138138
vdat_version()
139-
#> vdat-7.0.0-20231107-14c992-release
139+
#> vdat-9.13.2-20240607-7a2e9d-release
140140
```
141141

142142
Convert a VRL to CSV:
143143

144144
``` r
145145
## vdat_to_csv("SOME-VDAT-FILE")
146146
#> ✔ File converted:
147-
#> C:\Users\darpa2\AppData\Local\Temp\RtmpEDUiDu/readme_files/HR2-180 461396
147+
#> C:\Users\darpa2\AppData\Local\Temp\RtmpINUXfp/readme_files/HR2-180 461396
148148
#> 2021-04-20 173145.vdat
149149
#> ℹ File saved in:
150-
#> C:\Users\darpa2\AppData\Local\Temp\RtmpEDUiDu/readme_files/HR2-180 461396
150+
#> C:\Users\darpa2\AppData\Local\Temp\RtmpINUXfp/readme_files/HR2-180 461396
151151
#> 2021-04-20 173145.csv
152152
```
153153

@@ -156,17 +156,17 @@ Convert a VRL to a folder of CSVs split by data type:
156156
``` r
157157
## vdat_to_folder("SOME-VDAT-FILE")
158158
#> ✔ File converted:
159-
#> C:\Users\darpa2\AppData\Local\Temp\RtmpEDUiDu/readme_files/HR2-180 461396
159+
#> C:\Users\darpa2\AppData\Local\Temp\RtmpINUXfp/readme_files/HR2-180 461396
160160
#> 2021-04-20 173145.vdat
161161
#> ℹ Files saved in:
162-
#> C:\Users\darpa2\AppData\Local\Temp\RtmpEDUiDu/readme_files/HR2-180 461396
162+
#> C:\Users\darpa2\AppData\Local\Temp\RtmpINUXfp/readme_files/HR2-180 461396
163163
#> 2021-04-20 173145.csv-fathom-split
164164
## list.files("SOME-VDAT-FILE.csv-fathom-split")
165165
#> [1] "ATTITUDE.csv" "BATTERY.csv" "CFG_CHANNEL.csv"
166-
#> [4] "CFG_TRANSMITTER.csv" "CLOCK_SET.csv" "DATA_SOURCE_FILE.csv"
167-
#> [7] "DET.csv" "DET_FILTER.csv" "DIAG_HR2.csv"
168-
#> [10] "EVENT.csv" "EVENT_INIT.csv" "EVENT_OFFLOAD.csv"
169-
#> [13] "TEMP.csv"
166+
#> [4] "CFG_TRANSMITTER.csv" "CLOCK_REF.csv" "CLOCK_SET.csv"
167+
#> [7] "DATA_SOURCE_FILE.csv" "DET.csv" "DET_FILTER.csv"
168+
#> [10] "DIAG_HR2.csv" "EVENT.csv" "EVENT_INIT.csv"
169+
#> [13] "EVENT_OFFLOAD.csv" "TEMP.csv"
170170
```
171171

172172
Check out the file metadata:
@@ -450,11 +450,10 @@ vdat_template(format = "csv.fathom")
450450
#> [4] "Time Correction (s)" "Model" "Serial Number"
451451
#> [7] "Memory Remaining (%)" "Relative Humidity (%)" "RTC Time"
452452
#>
453-
#> $NOISE_DESC
454-
#> [1] "Device Time (UTC)" "Time" "Time Offset (h)"
455-
#> [4] "Time Correction (s)" "Model" "Serial Number"
456-
#> [7] "Channel 1 noise (TBD)" "Channel 2 noise (TBD)" "Channel 3 noise (TBD)"
457-
#> [10] "Channel 4 noise (TBD)"
453+
#> $HEALTH_NEXTRAK_DESC
454+
#> [1] "Device Time (UTC)" "Time" "Time Offset (h)"
455+
#> [4] "Time Correction (s)" "Model" "Serial Number"
456+
#> [7] "Memory Remaining (%)"
458457
#>
459458
#> $NOISE_STATS_VR2AR_DESC
460459
#> [1] "Device Time (UTC)" "Time"
@@ -493,88 +492,26 @@ vdat_template(format = "csv.fathom")
493492
#> [7] "Ambient Min (deg C)" "Ambient Max (deg C)"
494493
#> [9] "Ambient Mean (deg C)" "Sample Count"
495494
#> [11] "Accumulation Period (s)"
496-
#>
497-
#> $XPND_EVENT_DESC
498-
#> [1] "Device Time (UTC)" "Time"
499-
#> [3] "Time Offset (h)" "Time Correction (s)"
500-
#> [5] "Model" "Serial Number"
501-
#> [7] "Type" "Subtype"
502-
#> [9] "Description" "Values"
503-
#> [11] "Responder Model" "Responder Serial Number"
504-
#> [13] "Responder Range (m)" "Transmit Power (dB)"
505-
#> [15] "Receive Signal (dB)" "Receive Gain (dB)"
506-
#> [17] "Latitude" "Longitude"
507-
#> [19] "GPS HDOP"
508495
```
509496

510497
Call VDAT using standard flags:
511498

512499
``` r
513500
vdat_call("--help")
514-
#> VDAT File Tool
515-
#> Usage:
516-
#> vdat [OPTION...] [COMMAND [ARG]...]...
517-
#>
518-
#> Common options:
519-
#> --format FORMAT Output file format (e.g. csv.fathom, csv.fathom.split,
520-
#> json.rxlog)
521-
#> --output PATH Output file or directory path
522-
#>
523-
#> Conversion Options options:
524-
#> --timec OPTION Enable time correction (e.g. --timec=default)
525-
#> --detection-filter FILTER
526-
#> Detection filtering algorithm ???
527-
#> --tagdb FILEPATH Path of local tag database to be used for
528-
#> sensor value conversion.
529-
#> --offset-hours HOURS Offset times by a number of hours. Typically
530-
#> used to change time zone.
531-
#> --segment-hours HOURS Maximum data timespan (in hours) to include
532-
#> in each output file
533-
#>
534-
#> General options:
535-
#> -h, --help Print application help (and exit)
536-
#> -v, --version Print application version (and exit)
537-
#> --app-id Print application identity (and exit)
538-
#> --debug Enable debug mode
539-
#> -p, --progress Output realtime progress to the console
540-
#>
541-
#> Logging options:
542-
#> --log [=PATH(=C:\Users\darpa2\AppData\Local\Innovasea\VRPC\vdat)]
543-
#> Enable file logging. Explicit path is
544-
#> optional.
545-
#> --log-level LEVEL Set filter threshold for file logging [0
546-
#> (most verbose), 1000 (least verbose)]
547-
#> --trace Send all logging to console (no filtering)
548-
#> --trace-debug Send logging to console with debug-level
549-
#> filtering (200)
550-
#> --trace-info Send logging to console with info-level
551-
#> filtering (300)
552-
#>
553-
#> Commands:
554-
#> convert Convert file to the given file format
555-
#> . Usage: vdat convert --format=<FORMAT> <INPUT_FILEPATH>
556-
#> .
557-
#> . Optional: --output=<FILE_OR_DIRECTORY_PATH>
558-
#> . --timec=default
559-
#> . --detection-filter=<FILTER>
560-
#> . --tagdb=<FILEPATH>
561-
#> . --offset-hours=<HOURS>
562-
#> . --segment-hours=<HOURS>
563-
#> .
564-
#> . Example: vdat convert --format=csv.fathom <INPUT_FILEPATH>
565-
#> . vdat convert --format=json.rxlog <INPUT_FILEPATH>
566-
#>
567-
#> inspect Describe the content of an existing file
568-
#> . Usage: vdat inspect <INPUT_FILEPATH>
569-
#>
570-
#> template Generate template for a given file format
571-
#> . Usage: vdat template --format=<FORMAT>
572-
#> .
573-
#> . Optional: --output=<OUTPUT_FILEPATH>
574-
#> .
575-
#> . Example: vdat template --format=vfwp
576-
#>
501+
#> Usage: C:\PROGRA~1\INNOVA~1\Fathom\vdat.exe [OPTIONS] [SUBCOMMAND]
502+
#>
503+
#> Options:
504+
#> -h,--help Show help and summary of commands, or detailed
505+
#> help for selected command (and exit)
506+
#> --help-all Show help for all commands (and exit)
507+
#> -v,--version Print application version (and exit)
508+
#> --app-id Print application identity (and exit)
509+
#>
577510
#>
511+
#> Subcommands:
512+
#> convert Convert file to the given file format
513+
#> inspect Describe the content of an existing file
514+
#> template Generate template for a given file format
578515
```
579516

580517
## Development notes

‎vignettes/how-to-use-rvdat.Rmd

+24-38
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ vignette: >
1111

1212
This vignette is a working draft. There will be lots of changes as `rvdat` gets fleshed out, so please check back often!
1313

14-
The most recent changes were made on 2024-01-10.
14+
The most recent changes were made on 2024-07-08.
1515

1616
## Getting started
1717

@@ -86,20 +86,13 @@ inspect_df <- vdat_inspect(
8686
#>
8787

8888
head(inspect_df)
89-
#> variable
90-
#> 1 File
91-
#> 2 Original
92-
#> 3 Container
93-
#> 4 Created
94-
#> 5 Data UUID
95-
#> 6 Rx Model
96-
#> value
97-
#> 1 VR2AR_546310_20190613_1.vrl
98-
#> 2 VR2AR_546310_20190613_1.vrl
99-
#> 3 VR2AR VRL file (com.vemco.file.vrl.0207.ff02.ff02/5.0.1)
100-
#> 4 2019-06-13T13:30:54
101-
#> 5 ffee6ee7-450a-db42-b54c-334b672fddf5
102-
#> 6 VR2AR-69
89+
#> variable value
90+
#> 1 File VR2AR_546310_20190613_1.vrl
91+
#> 2 Original VR2AR_546310_20190613_1.vrl
92+
#> 3 Container VR2AR VRL file (com.vemco.file.vrl.0207.ff02.ff02/5.0.1)
93+
#> 4 Created 2019-06-13T13:30:54
94+
#> 5 Data UUID ffee6ee7-450a-db42-b54c-334b672fddf5
95+
#> 6 Rx Model VR2AR-69
10396
#> section
10497
#> 1 VRL
10598
#> 2 VRL
@@ -120,9 +113,9 @@ vdat_to_csv(
120113
outdir = td
121114
)
122115
#> ✔ File converted:
123-
#> C:\Users\darpa2\AppData\Local\Temp\Rtmp42s2YZ/vignette/VR2AR_546310_20190613_1.vrl
116+
#> C:\Users\darpa2\AppData\Local\Temp\RtmpuIFd1a/vignette/VR2AR_546310_20190613_1.vrl
124117
#> ℹ File saved in:
125-
#> C:\Users\darpa2\AppData\Local\Temp\Rtmp42s2YZ/vignette/VR2AR_546310_20190613_1.csv
118+
#> C:\Users\darpa2\AppData\Local\Temp\RtmpuIFd1a/vignette/VR2AR_546310_20190613_1.csv
126119

127120
list.files(td, pattern = "VR2AR")
128121
#> [1] "VR2AR_546310_20190613_1.csv" "VR2AR_546310_20190613_1.vrl"
@@ -136,14 +129,14 @@ vdat_to_csv(
136129
outdir = td
137130
)
138131
#> ✔ File converted:
139-
#> C:\Users\darpa2\AppData\Local\Temp\Rtmp42s2YZ/vignette/VR2AR_546310_20190613_1.vrl
132+
#> C:\Users\darpa2\AppData\Local\Temp\RtmpuIFd1a/vignette/VR2AR_546310_20190613_1.vrl
140133
#> ℹ File saved in:
141-
#> C:\Users\darpa2\AppData\Local\Temp\Rtmp42s2YZ/vignette/VR2AR_546310_20190613_1[20240110-11-00-35-xxxxxx].csv
134+
#> C:\Users\darpa2\AppData\Local\Temp\RtmpuIFd1a/vignette/VR2AR_546310_20190613_1[20240708-12-50-27-xxxxxx].csv
142135

143136
list.files(td, pattern = "VR2AR")
144137
#> [1] "VR2AR_546310_20190613_1.csv"
145138
#> [2] "VR2AR_546310_20190613_1.vrl"
146-
#> [3] "VR2AR_546310_20190613_1[20240110-11-00-35-794936].csv"
139+
#> [3] "VR2AR_546310_20190613_1[20240708-12-50-28-002297].csv"
147140
```
148141
## Converting a VDAT file to a CSV with time correction
149142

@@ -157,9 +150,9 @@ vdat_to_csv(
157150
time_corrected = TRUE
158151
)
159152
#> ✔ File converted:
160-
#> C:\Users\darpa2\AppData\Local\Temp\Rtmp42s2YZ/vignette/VR2AR_546310_20190613_1.vrl
153+
#> C:\Users\darpa2\AppData\Local\Temp\RtmpuIFd1a/vignette/VR2AR_546310_20190613_1.vrl
161154
#> ℹ File saved in:
162-
#> C:\Users\darpa2\AppData\Local\Temp\Rtmp42s2YZ/vignette/VR2AR_546310_20190613_1[20240110-11-00-36-xxxxxx].csv
155+
#> C:\Users\darpa2\AppData\Local\Temp\RtmpuIFd1a/vignette/VR2AR_546310_20190613_1[20240708-12-50-28-xxxxxx].csv
163156
```
164157

165158
A new column is added with time corrected down to the microsecond.
@@ -192,9 +185,9 @@ vdat_to_folder(
192185
outdir = td
193186
)
194187
#> ✔ File converted:
195-
#> C:\Users\darpa2\AppData\Local\Temp\Rtmp42s2YZ/vignette/VR2AR_546310_20190613_1.vrl
188+
#> C:\Users\darpa2\AppData\Local\Temp\RtmpuIFd1a/vignette/VR2AR_546310_20190613_1.vrl
196189
#> ℹ Files saved in:
197-
#> C:\Users\darpa2\AppData\Local\Temp\Rtmp42s2YZ/vignette/VR2AR_546310_20190613_1.csv-fathom-split
190+
#> C:\Users\darpa2\AppData\Local\Temp\RtmpuIFd1a/vignette/VR2AR_546310_20190613_1.csv-fathom-split
198191

199192
list.dirs(td, full.names = F, recursive = F)
200193
#> [1] "VR2AR_546310_20190613_1.csv-fathom-split"
@@ -273,20 +266,13 @@ hr_output <- vdat_inspect(file.path(td, "HR2-180 461396 2021-04-20 173145.vdat")
273266
#>
274267
#>
275268
head(hr_output)
276-
#> variable
277-
#> 1 File
278-
#> 2 Original
279-
#> 3 Container
280-
#> 4 Content
281-
#> 5 Created
282-
#> 6 File UUID
283-
#> value
284-
#> 1 HR2-180 461396 2021-04-20 173145.vdat
285-
#> 2 HR2-180 461396 2021-04-20 173145.vdat
286-
#> 3 Vemco Data File (com.vemco.file.vdat/1.0.0)
287-
#> 4 HR2 Receiver Data Pack (com.vemco.file.vrdp.vrhr2/1.0.0)
288-
#> 5 2021-04-20T17:31:45
289-
#> 6 f1a18604-46ea-4985-b57c-24809d37ad46
269+
#> variable value
270+
#> 1 File HR2-180 461396 2021-04-20 173145.vdat
271+
#> 2 Original HR2-180 461396 2021-04-20 173145.vdat
272+
#> 3 Container Vemco Data File (com.vemco.file.vdat/1.0.0)
273+
#> 4 Content HR2 Receiver Data Pack (com.vemco.file.vrdp.vrhr2/1.0.0)
274+
#> 5 Created 2021-04-20T17:31:45
275+
#> 6 File UUID f1a18604-46ea-4985-b57c-24809d37ad46
290276
#> section
291277
#> 1 VDAT
292278
#> 2 VDAT

0 commit comments

Comments
 (0)