Skip to content

Commit 98d7034

Browse files
committed
Update readme, canonical link to vdat
1 parent 83f3344 commit 98d7034

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

DESCRIPTION

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ License: AGPL (>= 3)
1010
URL: https://rvdat.obrien.page, https://github.com/mhpob/rvdat
1111
BugReports: https://github.com/mhpob/rvdat/issues
1212
SystemRequirements: VDAT command line tools
13-
(https://gitlab.oceantrack.org/otndc/vdat-working-group).
13+
(https://support.fishtracking.innovasea.com/s/downloads).
1414
Imports:
1515
cli,
1616
sys

README.Rmd

+1-2
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,7 @@ remotes::install_github("mhpob/rvdat")
9797
- [ ] ~~Time offset~~
9898
- Won't add; subtracts a number of hours from the time without being DST-aware.
9999
- [ ] ~~JSON template~~
100-
- The `json.rxlog` and `vfwp` formats noted in the help documentation return
101-
as invalid.
100+
- The `json.rxlog` and `vfwp` formats noted in the help documentation were for internal testing and not intended to be exposed. (See [this issue](https://github.com/mhpob/rvdat/issues/15#issuecomment-2214421397))
102101

103102

104103
## Using the package

README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,8 @@ remotes::install_github("mhpob/rvdat")
114114
DST-aware.
115115
- [ ] ~~JSON template~~
116116
- The `json.rxlog` and `vfwp` formats noted in the help documentation
117-
return as invalid.
117+
were for internal testing and not intended to be exposed. (See [this
118+
issue](https://github.com/mhpob/rvdat/issues/15#issuecomment-2214421397))
118119

119120
## Using the package
120121

@@ -143,10 +144,10 @@ Convert a VRL to CSV:
143144
``` r
144145
## vdat_to_csv("SOME-VDAT-FILE")
145146
#> ✔ File converted:
146-
#> C:\Users\darpa2\AppData\Local\Temp\RtmpgnQiad/readme_files/HR2-180 461396
147+
#> C:\Users\darpa2\AppData\Local\Temp\RtmpEDUiDu/readme_files/HR2-180 461396
147148
#> 2021-04-20 173145.vdat
148149
#> ℹ File saved in:
149-
#> C:\Users\darpa2\AppData\Local\Temp\RtmpgnQiad/readme_files/HR2-180 461396
150+
#> C:\Users\darpa2\AppData\Local\Temp\RtmpEDUiDu/readme_files/HR2-180 461396
150151
#> 2021-04-20 173145.csv
151152
```
152153

@@ -155,10 +156,10 @@ Convert a VRL to a folder of CSVs split by data type:
155156
``` r
156157
## vdat_to_folder("SOME-VDAT-FILE")
157158
#> ✔ File converted:
158-
#> C:\Users\darpa2\AppData\Local\Temp\RtmpgnQiad/readme_files/HR2-180 461396
159+
#> C:\Users\darpa2\AppData\Local\Temp\RtmpEDUiDu/readme_files/HR2-180 461396
159160
#> 2021-04-20 173145.vdat
160161
#> ℹ Files saved in:
161-
#> C:\Users\darpa2\AppData\Local\Temp\RtmpgnQiad/readme_files/HR2-180 461396
162+
#> C:\Users\darpa2\AppData\Local\Temp\RtmpEDUiDu/readme_files/HR2-180 461396
162163
#> 2021-04-20 173145.csv-fathom-split
163164
## list.files("SOME-VDAT-FILE.csv-fathom-split")
164165
#> [1] "ATTITUDE.csv" "BATTERY.csv" "CFG_CHANNEL.csv"
@@ -217,7 +218,7 @@ Check out the file metadata:
217218
See the fields associated with different data types:
218219

219220
``` r
220-
vdat_template(format = 'csv.fathom')
221+
vdat_template(format = "csv.fathom")
221222
#> $ATTITUDE_DESC
222223
#> [1] "Device Time (UTC)" "Time" "Time Offset (h)"
223224
#> [4] "Time Correction (s)" "Model" "Serial Number"

0 commit comments

Comments
 (0)