_pkgdown.yml

url: http://www.roald-arboel.com/animovement/

home:
  title: Analyse animal movement across space and time

authors:
  Mikkel Roald-Arbøl:
    href: https://roald-arboel.com

template:
  light-switch: true
  bootstrap: 5

reference:
- title: "Read"
  desc: These functions are the links between R and your data.
  contents:
  - read_animalta
  - read_bonsai
  - read_deeplabcut
  - read_idtracker
  - read_lightningpose
  - read_movement
  - read_sleap
  - read_trackball
  - read_treadmill
  - read_trex

- title: "Clean"
  desc: These functions ensure that your data is ready for analysis.
  contents:
  - check_na_timing
  - check_na_gapsize
  - check_confidence
  - check_pose
  - filter_na_confidence
  - filter_na_speed
  - filter_na_roi
  - replace_na
  - replace_na_linear
  - replace_na_locf
  - replace_na_spline
  - replace_na_stine
  - replace_na_locf
  - replace_na_value
  - filter_movement
  - filter_lowpass
  - filter_highpass
  - filter_lowpass_fft
  - filter_highpass_fft
  - filter_kalman
  - filter_kalman_irregular
  - filter_rollmean
  - filter_rollmedian
  - filter_sgolay

- title: "Transformations"
  desc: |
    These functions allow you to make tranformations to your coordinate system,
    such as translations, rotations or conversion to polar coordinates.
  contents:
  - transform_to_egocentric
  - translate_coords
  - rotate_coords
  - map_to_cartesian
  - map_to_polar

- title: "Calculate"
  desc: These functions are where your results begin to emerge.
  contents:
  - add_centroid
  - calculate_kinematics
  - calculate_statistics
  - calculate_derivative
  - calculate_direction
  - calculate_distance
  - calculate_speed
  - calculate_straightness

- title: "Metadata"
  desc: These functions allow you to interact with your metadata.
  contents:
  - init_metadata
  - get_metadata
  - set_uuid
  - set_start_datetime
  - set_framerate
  - set_individual

- title: "Helpers"
  desc: These functions help you along the way.
  contents:
  - get_example_data
  - group_every
  - align_timeseries
  - find_lag
  - find_peaks
  - find_troughs
  - plot_position_timeseries
  - plot_speed_timeseries
  - classify_by_stability
  - classify_by_threshold
  - classify_high_periods
  - classify_low_periods

navbar:
  components:
    tutorial:
      text: Tutorial
      menu:
      - text: Read trackball data
        href: articles/read-trackball.html
      - text: Clean tracks
        href: articles/clean-tracks.html
      - text: Calculate kinematics
        href: articles/calculate-kinematics.html
      - text: Calculate summary statistics
        href: articles/calculate-summary-statistics.html
    articles:
      text: Articles
      menu:
      - text: Mission & Scope
        href: articles/mission.html
      - text: Roadmaps
      - text: How to contribute
  structure:
    left:  [intro, tutorial, articles, reference, news]
    right: [search, github, lightswitch]