# --------------------------------------------
# CITATION file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# --------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "FishDiveR" in publications use:'
type: software
license: GPL-3.0-or-later
title: 'FishDiveR: Classify Aquatic Animal Behaviours from Vertical Movement Data'
version: 1.1.0
doi: 10.1186/s40462-025-00622-w
identifiers:
- type: doi
  value: 10.32614/CRAN.package.FishDiveR
abstract: Quantitatively analyse depth time-series data from pop-up satellite archival
  tags (PSATs) through the application of continuous wavelet transformation (CWT)
  combined with Principal Component Analysis (PCA), and k-means clustering. Import,
  crop, and plot depth time-depth records (TDRs). Using CWT to detect important signals
  within the non-stationary data, we create daily wavelet statistics to summarise
  vertical movements on different wavelet periods and combine with daily and diel
  depth statistics. Classify depth time-series with unsupervised k-means clustering
  into 24-hour periods of vertical movement behaviour with distinct patterns of vertical
  movement. Plot example days from each behaviour cluster, and plot the TDR coloured
  by cluster. Based on principals of combining CWT with k-means first developed by
  Sakamoto (2009) <https://doi.org/10.1371/journal.pone.0005379> and redeveloped by
  Beale (2026) <https://doi.org/10.21203/rs.3.rs-6907076/v1>.
authors:
- family-names: Beale
  given-names: Calvin
  email: calvin.beale.8@gmail.com
  orcid: https://orcid.org/0000-0002-3505-8929
preferred-citation:
  type: article
  title: 'FishDiveR: Wavelet analyses and machine learning provide robust classification
    of animal behaviour from time-depth data'
  authors:
  - family-names: Beale
    given-names: Calvin Steven
  - family-names: Gleiss
    given-names: Adrian
  journal: Movement Ecology
  year: '2026'
  volume: '14'
  issue: '8'
  doi: 10.1186/s40462-025-00622-w
  url: https://github.com/calvinsbeale/FishDiveR
  start: '16'
repository: https://calvinsbeale.r-universe.dev
repository-code: https://github.com/calvinsbeale/FishDiveR
commit: f2ccac2ca8dbe818ad4ca21d7b88d214e2490c22
url: https://github.com/calvinsbeale/FishDiveR
date-released: '2026-05-19'
contact:
- family-names: Beale
  given-names: Calvin
  email: calvin.beale.8@gmail.com
  orcid: https://orcid.org/0000-0002-3505-8929