source("setup.R")

This is an overview of how to use functions in the feedr package to transform and visual your RFID data. Note that while we've tried to explain the code in detail, if you are new to R, you may benefit from an introduction to coding in R before tackling your data with the feedr package

NOTE: As of Nov 10th, 2021, feedrshiny UI functions have been moved to thefeedrUI` package.

I'm in the process of updating this documentation (slowly!) so parts may seem out of date. Let me know (open an issue) if you find anything particularly problematic, thanks!

Order of operations

This package contains functions to perform three broad services:

  1. Loading/Importing Data
    Raw data directly from the loggers, or data already amalgamated
  2. Housekeeping
    Functions for checking and correcting errors before you transform the data
  3. Transformations
    Transforming raw data into visits, presence, activity, etc
  4. Visualizations
    Static or interactive maps produced by the mapping functions which visualize movements between and presence around the RFID loggers.

In the normal order of operations, several functions depend on the output of other functions.

For example, to get daily activity patterns, you could load your raw data with load_raw(), turn this raw data to visits data with visits(), turn visits data to activity data with activity() and finally, turn activity data into daily activity patterns with daily().

DiagrammeR::grViz("
digraph order {

graph [overlap = true, compound = true]

node[shape = Mrecord]
edge[arrowhead = vee]

load[label = '{Loading/Importing Data | {ui_import() | load_raw_all() | load_web()}}']

hk[label = '{Housekeeping (Optional) | {check_ids() | check_problems()}}', width = 3]

load -> hk
hk -> visits
load -> visits

visits[label = 'visits()']
disp[label = 'disp()']
dom[label = 'dom()']
move[label = 'move()']
presence[label = 'presence()']
act[label = 'activity()']
daily[label = 'daily()']

visits-> {disp, move, presence}
presence -> act
disp -> dom
act -> daily

map[label = '{Visualizations | {ui_animate() | map_leaflet()}}']
{presence; move} -> map
#A -> e [ltail = cluster0, lhead = cluster1]
#f -> 'visits()' [ltail = cluster1, lhead = cluster2]
#'move()' -> 'map_leaflet()' [ltail = cluster2, lhead = cluster3]
}
", width = 500)

Tutorial Data

Two data frames, finches and chickadees are included in the feedr package for the purpose of demonstration.

head(finches)
head(chickadees)

Function Index

Loading/Importing Data

Housekeeping

Transformations

Visualizations


Back to top
Continue with loading/importing data



animalnexus/feedr documentation built on Feb. 2, 2023, 1:12 a.m.