First v0.2 commit - animovement. Validators, tests, syntax changes

roaldarbol · Sep 9, 2024 · 32fba5e · 32fba5e
1 parent 4319da5
commit 32fba5e
Show file tree

Hide file tree

Showing 56 changed files with 1,061,735 additions and 504 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
-Package: trackballr
+Package: animovement
 Type: Package
-Title: R package for reading trackball data into a standard format
+Title: An R toolbox for analysing animal movement across space and time.
 Version: 0.1.2
 Authors@R: 
     person(
@@ -10,7 +10,7 @@ Authors@R:
       email = "trackballr.htmc8@passmail.net",
       comment = c(ORCID = "0000-0002-9998-0058")
       )
-Description: R package for reading trackball data into a standard format.
+Description: An R toolbox for analysing animal movement across space and time.
 License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
@@ -28,11 +28,13 @@ Suggests:
 Config/testthat/edition: 3
 Imports: 
     cli,
+    collapse,
     dplyr,
     rlang,
     tidyr,
     vroom,
     zoo
+Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.2
-URL: http://www.roald-arboel.com/trackballr/
+URL: http://www.roald-arboel.com/animovement/
 VignetteBuilder: knitr
diff --git a/LICENSE b/LICENSE
@@ -1,2 +1,2 @@
 YEAR: 2024
-COPYRIGHT HOLDER: trackballr authors
+COPYRIGHT HOLDER: animovement authors
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2024 trackballr authors
+Copyright (c) 2024 animovement authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/NAMESPACE b/NAMESPACE
@@ -1,12 +1,18 @@
 # Generated by roxygen2: do not edit by hand
 
 export(compute_kinematics)
+export(compute_statistics)
 export(read_trackball)
 export(smooth_track)
+export(validate_animalta)
+export(validate_deeplabcut_csv)
+export(validate_files)
+export(validate_time)
+export(validate_trackball)
 import(dplyr)
 importFrom(cli,cli_abort)
+importFrom(collapse,fmean)
 importFrom(rlang,":=")
 importFrom(rlang,.data)
-importFrom(stats,median)
 importFrom(vroom,vroom)
 importFrom(zoo,rollmean)
diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,17 @@
+# animovement 0.2.0
+
+**Package name changed to `animovement`!** To reflect the change in scope of the package to now cover a wide variety of movement data, the package has changed its name. This was a conscious decision as maintaining two packages with similar functionality wouldn't be feasible long-term. The new update brings with it a wealth of new functionality, but also a lot of breaking changes. With this update, the package aligns much closer to my vision for it, and I expect no more major breaking changes in the near future. So let's delve in to all the new stuff!
+
+* Much improved documentation
+* Added new readers `read_deeplabcut()`, `read_sleap()`, `read_trex()`...
+* Standardised data cleaning with `smooth_tracks()`
+* 
+* More tests
+
+Although this is annoying to current users, it was a necessity to ensure proper testing of all the various functions which have now been broken into smaller subsets. If you still need the former `trackballr` package functionality, you can download the source files in Github and [install from source](https://stackoverflow.com/a/1474125).
+
+If you encounter bugs, please report them in the [Github issues](https://github.com/roaldarbol/animovement/issues).
+
 # trackballr 0.1.2
 
 * Added tests for `read_trackball_data`

diff --git a/R/trackballr-package.R → R/animovement-package.R b/R/trackballr-package.R → R/animovement-package.R
diff --git a/R/read_animalta.R b/R/read_animalta.R
diff --git a/R/read_data.R b/R/read_data.R
diff --git a/R/read_deeplabcut.R b/R/read_deeplabcut.R
diff --git a/R/read_movement.R b/R/read_movement.R
diff --git a/R/read_sleap.R b/R/read_sleap.R