Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release version 0.8.0 #246

Merged
merged 374 commits into from
Sep 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
374 commits
Select commit Hold shift + click to select a range
00d5a26
Style code (GHA)
haydento Jan 23, 2024
a0c02f2
fixed debugging stuff
Jan 23, 2024
5efffdf
fixed something
Jan 23, 2024
735c22d
version up dev; 0.8.0.9003; fix #208
chrisholbrook Jan 23, 2024
d92b010
Merge branch 'dev' of https://github.com/mhpob/glatos into dev
mhpob Jan 23, 2024
b08dbb0
Merge branch 'dev' into dev-testthat-3e
mhpob Jan 23, 2024
b54940b
switch from sp to sf. see #205
mhpob Jan 24, 2024
15be927
roll back c71b570
mhpob Jan 24, 2024
c046cc5
add undeclared `zip` dependency in position_heat_map
mhpob Jan 24, 2024
e34860d
closes #209
mhpob Jan 24, 2024
6a31227
Style code (GHA)
mhpob Jan 24, 2024
a5a3e0d
lower limit for GH Actions Windows runner
mhpob Jan 24, 2024
d01b51b
style
mhpob Jan 24, 2024
8356d4f
clean up mess
mhpob Jan 24, 2024
5e6a8fd
Style code (GHA)
mhpob Jan 24, 2024
701983a
residence_index: rm int. namespace reference
mhpob Jan 24, 2024
1591ff8
read_glatos_receivers: rm int. namespace ref
mhpob Jan 24, 2024
70fc3cb
read_glatos_detections: rm int. namespace ref.
mhpob Jan 24, 2024
d71d33d
read_glatos_workbook: rm int. namespace ref.
mhpob Jan 24, 2024
1e30c4a
Add units package to imports
mhpob Jan 24, 2024
1ce0daa
move knitr and rmarkdown to Suggests; only used in vignettes and supp…
mhpob Jan 24, 2024
bce8c33
Add usethis to DESCRIPTION
mhpob Jan 24, 2024
08b0441
Rbuildignore util-intern_pkg_man to avoid usethis dependency. Prevent…
mhpob Jan 24, 2024
02b2dc4
move methods to Suggest; only used in suppl. docs.
mhpob Jan 24, 2024
eaa2893
remove fasttime. see #211
mhpob Jan 24, 2024
5cbff30
Fix bug in calc_collision_prob example
mhpob Jan 24, 2024
9e2ede7
Style code (GHA)
mhpob Jan 24, 2024
0af28a2
skip tests dependent on #202 fix
mhpob Feb 8, 2024
6209607
Style code (GHA)
mhpob Feb 8, 2024
89fe297
dt gives dt
mhpob Feb 8, 2024
9b6749f
Merge branch 'dev-testthat-3e' of https://github.com/mhpob/glatos int…
mhpob Feb 8, 2024
3176298
update actions/checkout to v4
mhpob Feb 9, 2024
cb9bb42
Merge pull request #204 from mhpob/dev-testthat-3e
jdpye Feb 9, 2024
5f82ea1
merge dev branch
mhpob Feb 9, 2024
ba7c2a2
Merge branch 'dev' into gh-actions-update
mhpob Feb 9, 2024
d2a56a3
missed a loose head
mhpob Feb 9, 2024
a6e1efd
add back zip dependency deleted during merge
mhpob Feb 9, 2024
4b06655
don't run test-vrl2csv on CRAN
mhpob Feb 9, 2024
9a7fd55
Merge pull request #216 from mhpob/patch-3
jdpye Feb 9, 2024
4e7495a
missed a skip_on_cran
mhpob Feb 9, 2024
11db48d
Merge pull request #217 from mhpob/patch-3
jdpye Feb 14, 2024
13c5709
Merge pull request #215 from mhpob/gh-actions-update
jdpye Feb 14, 2024
6711426
ran devtools::document()
jdpye Feb 15, 2024
8c2691d
fix uncommented title in vis-make_transition3 example
mhpob Feb 15, 2024
5dbdc53
fix uncommented line in example
mhpob Feb 15, 2024
3671779
Style code (GHA)
mhpob Feb 15, 2024
6ea4e5e
stylr
mhpob Feb 15, 2024
a014e97
dont run examples needing a fix to #202
mhpob Feb 15, 2024
8c4005e
Style code (GHA)
mhpob Feb 15, 2024
f41d26e
dont run examples that are supposed to error
mhpob Feb 15, 2024
dd1d8a6
Merge branch 'dev-internal-func-warnings' of https://github.com/mhpob…
mhpob Feb 15, 2024
e0ef774
Style code (GHA)
mhpob Feb 15, 2024
cced3b1
\dontrun didnt seem to work; commenting out the lines
mhpob Feb 15, 2024
4d2f9e8
Style code (GHA)
mhpob Feb 15, 2024
9383525
dont run example code made to show errors
mhpob Feb 15, 2024
452f4b8
Style code (GHA)
mhpob Feb 15, 2024
fefddd5
switch from \dontrun to try() so the error is shown without stoping eval
mhpob Feb 15, 2024
f4ab2cc
fix example_polygons location
mhpob Feb 15, 2024
51cc258
Style code (GHA)
mhpob Feb 15, 2024
890c433
fix accidental un-comment
mhpob Feb 15, 2024
b48345d
Merge branch 'dev-internal-func-warnings' of https://github.com/mhpob…
mhpob Feb 15, 2024
e7f353a
Style code (GHA)
mhpob Feb 15, 2024
f272c59
stylr
mhpob Feb 15, 2024
7b6452a
Call sf directly, remove extra #.
mhpob Feb 15, 2024
693a9a3
add terra to suggests as it is used in examples
mhpob Feb 15, 2024
690c760
Style code (GHA)
mhpob Feb 15, 2024
7d6c5a2
remove terra in examples, call correct raster::plot rather than base:…
mhpob Feb 16, 2024
8f631a3
Style code (GHA)
mhpob Feb 16, 2024
12e4736
dont run vdat examples
mhpob Feb 16, 2024
642d38c
Style code (GHA)
mhpob Feb 16, 2024
e403f6e
use gdal vsizip to skip the unzip step
mhpob Feb 16, 2024
f74ed99
R CMD check apparently only likes TRUE or FALSE rather than T or F
mhpob Feb 16, 2024
e868812
Missed some T and F
mhpob Feb 16, 2024
5c8a9e4
only fail on error, not warnings
mhpob Feb 16, 2024
a5f0b1b
Merge pull request #214 from mhpob/dev-internal-func-warnings
jdpye Feb 16, 2024
f016ab1
add missing @srs slot to greatLakesTrLayer; fix #213
chrisholbrook Feb 16, 2024
3fdcadb
fasttime -> fast_strptime. Closes #211.
mhpob Mar 7, 2024
1efd944
Style code (GHA)
mhpob Mar 7, 2024
d8185e4
Update style.yaml
mhpob Mar 7, 2024
6f903f0
Merge branch 'main' into dev
chrisholbrook Apr 9, 2024
9a5cbf1
Merge branch 'main' into dev
chrisholbrook Apr 9, 2024
fcb7990
Merge branch 'main' into dev
chrisholbrook Apr 9, 2024
d3681b6
Style code (GHA)
chrisholbrook Apr 9, 2024
8b58649
declare globals for residence_index; explicit use of dplyr::across
mhpob May 11, 2024
01227c1
explicitly use utils::head/tails to avoid abiguity warning
mhpob May 11, 2024
75f4d06
Declare globals: convert_glatos_to_att
mhpob May 11, 2024
ecd5140
Declare globals for convert_otn_erddap_to_att
mhpob May 11, 2024
62a4f15
Declare globals for convert_otn_to_att
mhpob May 11, 2024
f3573df
explicit use of utils::tail
mhpob May 11, 2024
a0116dd
define globals: detect_transmissions
mhpob May 11, 2024
833fed3
call great_lakes_polygon without using global variable
mhpob May 11, 2024
1b18373
declare globals: interpolate_path
mhpob May 11, 2024
032b17c
wrong argument: kml_file -> filePath
mhpob May 11, 2024
b92fa5e
declare globals: kml_workbook
mhpob May 11, 2024
93ff7d7
declare globals: make_frames
mhpob May 11, 2024
78a837d
declare globals: min_lag
mhpob May 11, 2024
13f1252
declare globals: prepare_deploy_sheet
mhpob May 11, 2024
b6cff76
declare globals: prepare_tag_sheet
mhpob May 11, 2024
6d54ac3
Merge branch 'dev' into dev-declare-globals
mhpob May 11, 2024
41ddd98
Update documentation
mhpob May 11, 2024
66b33f8
Update documentation
mhpob May 11, 2024
a7295d6
declare globals; call vdat_csv_schema without global var; call stats:…
mhpob May 11, 2024
f553dc0
Merge branch 'dev-declare-globals' of https://github.com/mhpob/glatos…
mhpob May 11, 2024
1fb9fc7
Declare globals: real_sensor_values
mhpob May 11, 2024
f63a2d9
declare globals: REI
mhpob May 11, 2024
e27d229
declare globals: summarize_detections
mhpob May 11, 2024
0fa0d26
declare globals: transmit_along_path
mhpob May 11, 2024
c9ff4d4
declare globals: vdat_convert
mhpob May 11, 2024
4478bdc
declare globals: vue_convert
mhpob May 11, 2024
110b910
declare globals: write_vdat_csv; explicitly call stats::setNames and …
mhpob May 11, 2024
709f0f2
Style code (GHA)
mhpob May 11, 2024
67fa300
Add kml_to_csv test
mhpob May 11, 2024
e32cdce
Merge branch 'dev-declare-globals' of https://github.com/mhpob/glatos…
mhpob May 11, 2024
7564865
Style code (GHA)
mhpob May 11, 2024
e625332
fix partial match
mhpob May 11, 2024
1a9e7dc
call utils::data
mhpob May 11, 2024
484d4f5
load data into function's environment rather than global user environ…
mhpob May 11, 2024
802d3c7
fix introduced utils::data bug
mhpob May 11, 2024
f885ff2
Style code (GHA)
mhpob May 11, 2024
d8073d9
fix introduced utils::data bug
mhpob May 11, 2024
d9f5651
Stylr
mhpob May 11, 2024
ab22ef9
Style code (GHA)
mhpob May 11, 2024
4e3b8ef
missed a utils
mhpob May 11, 2024
31aa760
expect_identical to expect_equal to avoid floating point issues
mhpob May 11, 2024
3c66ebf
Merge branch 'dev-declare-globals' of https://github.com/mhpob/glatos…
mhpob May 11, 2024
2adc262
Update documentation
mhpob May 11, 2024
edc1017
Fix forgotten NULL
mhpob May 13, 2024
faf6fac
Style code (GHA)
mhpob May 13, 2024
047f150
fix latex escape and invalid alias tagging
mhpob May 13, 2024
bcdd387
fix latex escape
mhpob May 13, 2024
1f47093
fix misspecified itemize list
mhpob May 13, 2024
58aea3b
Merge branch 'dev-declare-globals' of https://github.com/mhpob/glatos…
mhpob May 13, 2024
81a0b81
fix misspecified itemize list
mhpob May 13, 2024
f4a21c8
fix rd link
mhpob May 13, 2024
642a77c
fix missing link by rm
mhpob May 13, 2024
07ff39b
backtick so roxygen doesn interpret boxed code as a link
mhpob May 13, 2024
d520fc7
useage to example
mhpob May 13, 2024
9735e5e
Style code (GHA)
mhpob May 13, 2024
f2e4173
add back global dot var
mhpob May 13, 2024
0638483
example -> exampleS
mhpob May 13, 2024
95529b8
Update documentation
mhpob May 13, 2024
2816146
remove units dependency
mhpob May 13, 2024
40285c2
tibble::tibble to dplyr::tibble
mhpob May 13, 2024
5f2e572
magrittr::`%>%` to dplyr::`%>%`
mhpob May 13, 2024
3767ab6
sub capture instead of tidyr::extract
mhpob May 13, 2024
c7fc9f2
Style code (GHA)
mhpob May 13, 2024
306fe83
don't document internal functions
mhpob May 16, 2024
2f3eb22
fix extra space in documentation causing it to not be picked up as a …
mhpob May 16, 2024
f8bcb84
Document [.vdat_list args and add placeholder export_settings arg
mhpob May 16, 2024
aa0b5be
Style code (GHA)
mhpob May 16, 2024
089e883
Add missing comment in unrun example
mhpob May 16, 2024
67266c1
Style code (GHA)
mhpob May 16, 2024
980a458
rm geosphere
mhpob May 23, 2024
28550d6
drop geosphere in favor of hard-coded haversine
mhpob May 24, 2024
dec4ece
rm geosphere
mhpob May 24, 2024
f88fcb4
rm geosphere. closes #235
mhpob May 24, 2024
9016179
Merge branch 'dev-rm-geosphere' of https://github.com/mhpob/glatos in…
mhpob May 24, 2024
64237d6
Add initial tests for point_offset
mhpob May 24, 2024
0750b57
Add initial interpolate_path tests
mhpob May 24, 2024
c64e8c9
Style code (GHA)
mhpob May 24, 2024
05da3b5
Merge pull request #223 from mhpob/dev-fasttime-fix
chrisholbrook Aug 14, 2024
e891deb
Update documentation
chrisholbrook Aug 14, 2024
f9a65ca
Merge pull request #228 from mhpob/dev-declare-globals
chrisholbrook Aug 14, 2024
d4d106f
Merge pull request #229 from mhpob/dev-no-units-dep
chrisholbrook Aug 14, 2024
8c54fd4
Merge branch 'dev' into dev-no-tibble
chrisholbrook Aug 15, 2024
34eecfd
Merge pull request #230 from mhpob/dev-no-tibble
chrisholbrook Aug 15, 2024
34a7cc2
Merge branch 'dev' into dev-no-rd-internal
chrisholbrook Aug 15, 2024
58cba3b
Update documentation
chrisholbrook Aug 15, 2024
0e04039
Merge pull request #232 from mhpob/dev-no-rd-internal
chrisholbrook Aug 15, 2024
88a2226
Style code (GHA)
chrisholbrook Aug 15, 2024
222cd6c
Merge branch 'dev' into dev-rm-geosphere
chrisholbrook Aug 16, 2024
d4ca28b
Style code (GHA)
chrisholbrook Aug 16, 2024
a20ca37
Merge pull request #236 from mhpob/dev-rm-geosphere
chrisholbrook Aug 16, 2024
dbe7280
version up dev (0.8.9006); add mhpob as ctb
chrisholbrook Aug 16, 2024
5609c61
suppress dplyr::left_join warning (Detected an unexpected many-to-man…
chrisholbrook Aug 18, 2024
deeadaf
use sf::st_crs() instead of sp::CRS(); change name of ATT example obj…
chrisholbrook Aug 18, 2024
503c394
complete previous commit; use sf::st_crs() instead of sp::CRS(); chan…
chrisholbrook Aug 18, 2024
e5f1fef
remove duplicate concat_list_strings(); fixes #199
chrisholbrook Aug 18, 2024
619795e
add 'silent' arg to query_worms_common(); set silent = TRUE when call…
chrisholbrook Aug 18, 2024
928008c
add dplyr::all_of() to avoid warning 'Using an external vector in sel…
chrisholbrook Aug 18, 2024
a76d32a
suppress messages during unit testing
chrisholbrook Aug 18, 2024
0e69c04
add tests for internal functions lonlat_to_utm() and utm_tolonlat(); …
chrisholbrook Aug 19, 2024
2784884
fix bug in utm_to_lonlat(); missing lonlat
chrisholbrook Aug 19, 2024
ebdd870
add showProgress arg to vrl2csv and pipe some tests to simplify devto…
chrisholbrook Aug 19, 2024
a64330e
change tibble::as_tibble to dplyr::as_tibble
chrisholbrook Aug 19, 2024
2131f69
remove all 'glatos::' and 'glatos:::'
chrisholbrook Aug 19, 2024
f770df4
version up dev 0.8.0.9007
chrisholbrook Aug 19, 2024
e99bb84
Style code (GHA)
chrisholbrook Aug 19, 2024
0b89b0b
reinstate changes from #228 that were lost during merge conflict reso…
chrisholbrook Aug 22, 2024
4ed9d88
resolve R CMD CHECK 'no visibile bindings...' warning
chrisholbrook Aug 22, 2024
e69a87e
Style code (GHA)
chrisholbrook Aug 22, 2024
40081f3
add tibble to suggests to quiet R CMD check warning
chrisholbrook Aug 22, 2024
dd93ccb
Merge branch 'dev' of github.com:ocean-tracking-network/glatos into dev
chrisholbrook Aug 22, 2024
51a6aab
use dplyr::tibble in tests and examples to quite R CMD CHECK warning;…
chrisholbrook Aug 22, 2024
609571e
Drop dependency on purrr by changing to sapply.
mhpob Aug 25, 2024
2086d6e
Style code (GHA)
mhpob Aug 25, 2024
ae35104
create list when multiple scientific names match common names.
mhpob Aug 25, 2024
825084d
Re-build blue_shark_att to fix #240.
mhpob Aug 27, 2024
fc68b2b
Add tests for internal helper functions.
mhpob Aug 27, 2024
3976a0b
Flag missing test.
mhpob Aug 27, 2024
84b8664
Style code (GHA)
mhpob Aug 27, 2024
5668ee8
add new function 'jarasterize()'; remove fasterize dependency; remove…
chrisholbrook Aug 28, 2024
7417fce
update doc
chrisholbrook Aug 28, 2024
e0b5a80
Style code (GHA)
chrisholbrook Aug 28, 2024
685c047
fix /dontrun
chrisholbrook Aug 29, 2024
9238725
declare global variables for R CMD check
chrisholbrook Aug 29, 2024
3cb0ecb
fix typos in help
chrisholbrook Aug 29, 2024
02a8489
restore help for greatLakesPoly
chrisholbrook Aug 29, 2024
d012076
remove redundant alias
chrisholbrook Aug 29, 2024
3ca44ce
add vdat_csv_schema help
chrisholbrook Aug 29, 2024
d3e8b4e
replace spaces with _ in HR2 file name
chrisholbrook Aug 29, 2024
5a3fda7
Style code (GHA)
chrisholbrook Aug 29, 2024
c8ca65b
add params to deprecated help
chrisholbrook Aug 29, 2024
716251f
Merge branch 'dev' of github.com:ocean-tracking-network/glatos into dev
chrisholbrook Aug 29, 2024
4d2c768
Update documentation
chrisholbrook Aug 29, 2024
46c9756
Merge pull request #238 from mhpob/dev-rm-purrr
chrisholbrook Aug 29, 2024
e9f2668
fix typos in doc
chrisholbrook Aug 29, 2024
7cae61b
remove internal function check_in_polygon (not used), rename check_cr…
chrisholbrook Aug 29, 2024
01a4d65
add tests for summarize_detections; fixes #220
chrisholbrook Aug 30, 2024
11f551d
add tests for constructors; version up dev 0.8.0.9009
chrisholbrook Aug 30, 2024
52e15ba
Style code (GHA)
chrisholbrook Aug 30, 2024
a859b88
fix dplyr namespace
chrisholbrook Aug 30, 2024
c6a10d1
fix dplyr namespace
chrisholbrook Aug 30, 2024
4ac0e79
Style code (GHA)
chrisholbrook Aug 30, 2024
7ba8d53
add back noRd tag
chrisholbrook Aug 30, 2024
6f1d61c
Merge branch 'dev' of github.com:ocean-tracking-network/glatos into dev
chrisholbrook Aug 30, 2024
9da125c
add tests for vue and vdat load functions
chrisholbrook Sep 2, 2024
f9486cb
add tests write_vdat_csv
chrisholbrook Sep 3, 2024
6fa9ec3
add tests
chrisholbrook Sep 4, 2024
8e9644a
Style code (GHA)
chrisholbrook Sep 4, 2024
27bc388
skip test on ci
chrisholbrook Sep 4, 2024
ad941b2
Merge branch 'dev' of github.com:ocean-tracking-network/glatos into dev
chrisholbrook Sep 4, 2024
a5884c9
skip test on ci
chrisholbrook Sep 4, 2024
263ee71
remove os-specific snapshot (png)
chrisholbrook Sep 5, 2024
544e747
Style code (GHA)
chrisholbrook Sep 5, 2024
a48ee7f
lower min file size or OS-agnostic test
chrisholbrook Sep 5, 2024
b0c7b8c
support vdat-10.6.0
chrisholbrook Sep 5, 2024
0bf25a6
Style code (GHA)
chrisholbrook Sep 5, 2024
757dc6d
require R >= 3.6 (for readxl)
chrisholbrook Sep 5, 2024
33d0e44
use showNonASCII to check without using; avoid R CMD check warning
chrisholbrook Sep 18, 2024
e66175c
update data loading vignette; rebuild vignettes; update NEWS
chrisholbrook Sep 18, 2024
7e7ca2b
Style code (GHA)
chrisholbrook Sep 18, 2024
95dde14
update readme and use as package help (as child in md)
chrisholbrook Sep 19, 2024
8f92df1
package help cleanup
chrisholbrook Sep 19, 2024
75d1b0d
remove pre-release label (0.8.0)
chrisholbrook Sep 19, 2024
ebeca22
Merge branch 'dev' of github.com:ocean-tracking-network/glatos into dev
chrisholbrook Sep 19, 2024
a99c0ee
Style code (GHA)
chrisholbrook Sep 19, 2024
bd13c98
rebuild package help
chrisholbrook Sep 19, 2024
aa2129a
Merge branch 'dev' of github.com:ocean-tracking-network/glatos into dev
chrisholbrook Sep 19, 2024
4287bb8
rebuild package help; hardcode current version
chrisholbrook Sep 19, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
^Meta$
^doc$
ReadMe.md
CONTRIBUTING.md
glatos.pdf
^ReadMe\.md$
^CONTRIBUTING\.md$
^glatos\.pdf$
^data-raw$
^.*\.Rproj$
^\.Rproj\.user$
^README\.Rmd$
^README-.*\.png$
^\.github$
^R/util-intern_pkg_man\.r$
1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
50 changes: 50 additions & 0 deletions .github/workflows/R-CMD-check.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
branches: [main, dev]
pull_request:
branches: [main, dev]

name: R-CMD-check

jobs:
R-CMD-check:
runs-on: ${{ matrix.config.os }}

name: ${{ matrix.config.os }} (${{ matrix.config.r }})

strategy:
fail-fast: false
matrix:
config:
- {os: macos-latest, r: 'release'}
- {os: windows-latest, r: 'release'}
- {os: ubuntu-latest, r: 'devel', http-user-agent: 'release'}
- {os: ubuntu-latest, r: 'release'}
- {os: ubuntu-latest, r: 'oldrel-1'}

env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
R_KEEP_PKG_SOURCE: yes

steps:
- uses: actions/checkout@v4

- uses: r-lib/actions/setup-pandoc@v2

- uses: r-lib/actions/setup-r@v2
with:
r-version: ${{ matrix.config.r }}
http-user-agent: ${{ matrix.config.http-user-agent }}
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::rcmdcheck
needs: check

- uses: r-lib/actions/check-r-package@v2
with:
upload-snapshots: true
error-on: '"error"'
42 changes: 42 additions & 0 deletions .github/workflows/document.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
paths: ["R/**"]

name: Document

jobs:
document:
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:
- name: Checkout repo
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Setup R
uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true

- name: Install dependencies
uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::roxygen2
needs: roxygen2

- name: Document
run: roxygen2::roxygenise()
shell: Rscript {0}

- name: Commit and push changes
run: |
git config --local user.name "$GITHUB_ACTOR"
git config --local user.email "[email protected]"
git add man/\* NAMESPACE DESCRIPTION
git commit -m "Update documentation" || echo "No changes to commit"
git pull --ff-only
git push origin
79 changes: 79 additions & 0 deletions .github/workflows/pr-commands.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
issue_comment:
types: [created]

name: Commands

jobs:
document:
if: ${{ github.event.issue.pull_request && (github.event.comment.author_association == 'MEMBER' || github.event.comment.author_association == 'OWNER') && startsWith(github.event.comment.body, '/document') }}
name: document
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v4

- uses: r-lib/actions/pr-fetch@v2
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}

- uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true

- uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::roxygen2
needs: pr-document

- name: Document
run: roxygen2::roxygenise()
shell: Rscript {0}

- name: commit
run: |
git config --local user.name "$GITHUB_ACTOR"
git config --local user.email "[email protected]"
git add man/\* NAMESPACE
git commit -m 'Document'

- uses: r-lib/actions/pr-push@v2
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}

style:
if: ${{ github.event.issue.pull_request && (github.event.comment.author_association == 'MEMBER' || github.event.comment.author_association == 'OWNER') && startsWith(github.event.comment.body, '/style') }}
name: style
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v3

- uses: r-lib/actions/pr-fetch@v2
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}

- uses: r-lib/actions/setup-r@v2

- name: Install dependencies
run: install.packages("styler")
shell: Rscript {0}

- name: Style
run: styler::style_pkg()
shell: Rscript {0}

- name: commit
run: |
git config --local user.name "$GITHUB_ACTOR"
git config --local user.email "[email protected]"
git add \*.R
git commit -m 'Style'

- uses: r-lib/actions/pr-push@v2
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
73 changes: 73 additions & 0 deletions .github/workflows/style.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
on:
push:
paths: ["**.[rR]", "**.[qrR]md", "**.[rR]markdown", "**.[rR]nw", "**.[rR]profile"]

name: Style

jobs:
style:
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
steps:
- name: Checkout repo
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Setup R
uses: r-lib/actions/setup-r@v2
with:
use-public-rspm: true

- name: Install dependencies
uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages: any::styler, any::roxygen2
needs: styler

- name: Enable styler cache
run: styler::cache_activate()
shell: Rscript {0}

- name: Determine cache location
id: styler-location
run: |
cat(
"location=",
styler::cache_info(format = "tabular")$location,
"\n",
file = Sys.getenv("GITHUB_OUTPUT"),
append = TRUE,
sep = ""
)
shell: Rscript {0}

- name: Cache styler
uses: actions/cache@v4
with:
path: ${{ steps.styler-location.outputs.location }}
key: ${{ runner.os }}-styler-${{ github.sha }}
restore-keys: |
${{ runner.os }}-styler-
${{ runner.os }}-

- name: Style
run: styler::style_pkg()
shell: Rscript {0}

- name: Commit and push changes
run: |
if FILES_TO_COMMIT=($(git diff-index --name-only ${{ github.sha }} \
| egrep --ignore-case '\.(R|[qR]md|Rmarkdown|Rnw|Rprofile)$'))
then
git config --local user.name "$GITHUB_ACTOR"
git config --local user.email "[email protected]"
git commit ${FILES_TO_COMMIT[*]} -m "Style code (GHA)"
git pull --ff-only
git push origin
else
echo "No changes to commit."
fi
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You may have a feature or function that you'd like to contribute to the package.
Clone the `glatos` repository onto your local machine. On the command line, you would CD to a working directory, then do:

```
git clone git@gitlab.oceantrack.org:GreatLakes/glatos.git
git clone git@github.com:ocean-tracking-network/glatos.git
cd glatos
git fetch
git checkout -b dev origin/dev
Expand All @@ -36,17 +36,17 @@ git push -u origin myfeature

You can push to your feature branch as many times as you like, this way you and another developer can collaborate on the feature, or just when you've reached a point that you feel you're ready to come back into the main package.

Finally, alert the package maintainers (@chrisholbrook , @trbinder , @thayden , @frank.smith , @jdpye) that your feature's ready for integration with `dev` by issuing a [Merge Request](https://gitlab.oceantrack.org/GreatLakes/glatos/merge_requests) for `myfeature` into `dev`. GitLab will run the reports on what you've changed and how it affects the current state of the `dev` branch, even if the `dev` branch has changed since you last checked!
Finally, alert the package maintainers (@chrisholbrook , @trbinder , @thayden , @frank.smith , @jdpye) that your feature's ready for integration with `dev` by issuing a [Pull Request](https://github.com/ocean-tracking-network/glatos/pulls) for `myfeature` into `dev`. GitHub will run the reports on what you've changed and how it affects the current state of the `dev` branch, even if the `dev` branch has changed since you last checked!

Responsibility for making sure your branch won't break everything now falls to the package maintainers. They'll merge in your feature if it's in good working order and it will be further tested and then eventually merged into the `master` branch, from which all the end-users of the `glatos` package run code.
Responsibility for making sure your branch won't break everything now falls to the package maintainers. They'll merge in your feature if it's in good working order and it will be further tested and then eventually merged into the `master` branch, from which all the end-users of the `glatos` package run code.

In the near future, testing will be an important part of contributing code to the package. Any tests that you can write to verify the integrity of your feature will be included as part of the build procedure for releasing official versions of `glatos`. Add them in a subfolder called `tests\myfeature` where myfeature is the name of your feature. For testing, the R package [testthat](https://cran.r-project.org/web/packages/testthat/testthat.pdf) is a good starting point.
In the near future, testing will be an important part of contributing code to the package. Any tests that you can write to verify the integrity of your feature will be included as part of the build procedure for releasing official versions of `glatos`. Add them in a subfolder called `tests\myfeature` where myfeature is the name of your feature. For testing, the R package [testthat](https://cran.r-project.org/web/packages/testthat/testthat.pdf) is a good starting point.

Documentation is done using the [roxygen](https://cran.r-project.org/web/packages/roxygen2/vignettes/rd.html) package and associated notation, so annotating your feature's functions in that way will be most helpful for integration purposes.

## Method 2: The 'Wishing Well' Method

If all that sounded quite complicated, and you'd like to see a feature added to the package, but can only describe it in plain English and not in a sweet, sweet .R file full of declarative statements and function calls, then create an [Issue](https://gitlab.oceantrack.org/GreatLakes/glatos/issues), describe what you'd like to see in the new feature, and assign it the Feature Request label. From there, any member of the community could pounce on your idea, assign it to themselves, write and commit it and claim ~~all~~ an appropriate amount of the credit.
If all that sounded quite complicated, and you'd like to see a feature added to the package, but can only describe it in plain English and not in a sweet, sweet .R file full of declarative statements and function calls, then create an [Issue](https://github.com/ocean-tracking-network/glatos/issues), describe what you'd like to see in the new feature, and assign it the Feature Request label. From there, any member of the community could pounce on your idea, assign it to themselves, write and commit it and claim ~~all~~ an appropriate amount of the credit.


In either contribution paradigm, providing supporting literature for the analysis methods you propose should be prioritized. Everyone likes to see their name in a references list, and collaborative analysis packages can be a great way to get some sunshine on that analysis method you really like.
Expand Down
36 changes: 17 additions & 19 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,32 @@ 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.7.3
Date: 2024-04-09
Depends: R (>= 3.5.0)
Version: 0.8.0
Date: 2024-09-18
Depends: R (>= 3.6.0)
Imports:
av,
data.table,
fasterize,
fasttime,
gdalUtilities,
data.table,
dplyr,
geodist,
gdistance,
jsonlite,
knitr,
lubridate,
magrittr,
methods,
plotrix,
plyr,
purrr,
raster,
readxl,
rmarkdown,
sf,
tibble,
tidyr
sp,
zip
Suggests:
gganimate,
gifsky,
GISTools,
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
Expand All @@ -41,13 +37,15 @@ Authors@R: c(
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.1
RoxygenNote: 7.3.2
VignetteBuilder: knitr
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
Config/testthat/edition: 3
Binary file modified Meta/vignette.rds
Binary file not shown.
Loading