Man pages for edwardlavender/flapper
Routines for the Analysis of Passive Acoustic Telemetry Data

acThe acoustic-container (AC) algorithm
acdcThe acoustic-container depth-contour (ACDC) algorithm
acdc_accessShort-cuts to elements of an '"acdc_record"' object
acdc_animate_recordCreate a html animation of the AC/DC algorithm(s)
acdc_archive-class"acdc-archive" class
acdc_plot_recordPlot time-specific maps from the AC/DC algorithm(s)
acdc_plot_tracePlot AC* container dynamics
acdc_record-class"acdc_record" class
acdc_simplifySimplify the outputs of the AC/DC algorithms
acs_setup_containersSetup the detection containers required for the AC*...
acs_setup_detection_kernelsSetup detection probability kernels for the AC* algorithm(s)
acs_setup_mobilityExamine the constant 'mobility' assumption of the AC*...
assemble_sentinel_countsAssemble counts of transmissions/detections from sentinel...
buffer_and_cropBuffer and crop a spatial object
cells_from_valObtain a RasterLayer or the cells of RasterLayer that are...
check...Check that arguments supplied via '...' are allowed
check_classCheck the class of a function input to a parent function
check_class_acdc_recordCheck an object is of class '"acdc_record"'
check_crsCheck coordinate reference systems match
check_dirCheck a directory exists
check_named_listCheck that a list is named
check_namesCheck the names of an object contain required names
check_tzCheck the time zone of an object and force UTC if absent
check_valueCheck the input value to a parent function argument
clParallelisation helpers
coaThe centres of activity (COA) algorithm
coa_setup_delta_tSuggest time intervals over which to calculate centres of...
compactCompact a list
crop_from_clickInteractively crop a 'raster'
dat_acdcExample ACDC algorithm output
dat_acousticsExample passive acoustic telemetry detections dataset
dat_archivalExample archival dataset
dat_coastThe coastline around the MEFS Firth of Lorn acoustic array
dat_containersExample detection containers from 'acs_setup_containers'
dat_dcExample DC algorithm output
dat_dcpf_historiesExample DCPF algorithm output: particle histories
dat_dcpf_pathsExample DCPF algorithm output: reconstructed paths
dat_gebcoThe bathymetry around the MEFS Firth of Lorn acoustic array
dat_idsExample tagged individuals dataset
dat_mooringsExample passive acoustic telemetry receiver moorings dataset
dat_sentinelExample sentinel tag range testing dataset
dcThe depth-contour (DC) algorithm
dcqThe 'quick' depth-contour (DCQ) algorithm
dist_btw_clicksCalculate the distance between sequential mouse clicks on a...
dist_btw_points_3dCalculate the Euclidean distance(s) between points in...
dist_btw_receiversCompute Euclidean distances between receivers
dist_over_surfaceCalculate the total distance of a path over a...
dot-acsBack-end implementation of the AC and ACDC algorithms
dot-acs_plIntermediate wrapper for '.acs' that supports parallelisation
dot-planedist2Calculate a matrix of Euclidean distances between points
eval_by_kudEvaluate movement path estimates using kernel utilisation...
flapper'flapper': Routines for the analysis of passive acoustic...
flapper_optsGlobal example controls
flapper-tips-parallelParallelisation in 'flapper'
get_detection_area_sumCalculate the total area sampled by acoustic receivers
get_detection_area_tsCalculate the area sampled by receivers through time
get_detection_clumpsGet detection clumps
get_detection_containersDefine detection containers around receivers
get_detection_containers_envirSample environmental conditions around receivers
get_detection_containers_overlapGet detection container overlaps
get_detection_daysCalculate detection days
get_detection_overlapsGet 'overlapping' detections
get_detection_prA detection probability function based on distance
get_hrGet animal 'home ranges'
get_id_rec_overlapCalculate the overlap between individuals' time at liberty...
get_intersectionSpatial intersections with one or more geometries
get_mvt_mobilityEstimate individual swimming speeds from acoustic and...
get_mvt_restingIdentify resting behaviour within depth time series
get_n_operational_tsCalculate the number of operational units through time
get_residentsIdentify 'resident' individuals in a passive acoustic...
invert_polyInvert a (spatial) polygon
kud_around_coastlineProcess a kernel utilisation distribution around a barrier
kud_habitatDefine a 'habitat' grid for kernel smoothing
lcp_compCompare Euclidean and shortest distances
lcp_costsCalculate the distances between connected cells in a Raster*
lcp_from_pointCreate a Raster* of the least-cost distances around a point
lcp_graph_surfaceConstruct a graph for least-cost paths analysis of movement...
lcp_interpInterpolate shortest (least-cost) paths between locations...
lcp_over_surfaceCalculate shortest path(s) and/or distance(s) over a surface...
make_df_detectionsConvert a detection matrix into a dataframe
make_matrix_cooccurenceCompute a detection history similarity matrix
make_matrix_detectionsMatricise detection time series
make_matrix_idsMatricise individual deployment time series
make_matrix_receiversMatricise receiver deployment time series
mask_ioImplement 'mask' using the inside or outside of the mask
pfThe particle filtering routine
pf_access_historyAccess the 'history' element of a 'pf_archive-class' object
pf_access_history_filesList 'history' files from a PF algorithm
pf_access_particles_uniqueAccess the cells sampled by PF
pf_animate_historyCreate a html animation of the PF algorithm(s)
pf_archive-class"pf_archive" class
pf_kudSmooth POU maps
pf_kud_(Experimental) Alternative kernel smoothing routines for...
pf_loglikCalculate the log-probability of movement paths from a PF...
pf_path-class"pf" class
pf_plot_1dPlot one-dimensional depth time series from a PF algorithm
pf_plot_2dMap two-dimensional paths from a PF algorithm
pf_plot_3dMap three-dimensional paths from a PF algorithm
pf_plot_historyPlot particle histories from a PF algorithm
pf_plot_mapPlot 'probability of use' from a PF algorithm
pf_setup_movement_prA simple movement model dependent on distance
pf_setup_optimisersOptimisation settings for 'pf'
pf_setup_recordList 'record' files from an AC/DC algorithm for PF
pf_simplifyConvert particle histories from 'pf' into movement paths
pipePipe operator
process_false_detections_sfPass putative false detections through a spatial filter
process_quality_checkBasic quality checks of passive acoustic telemetry datasets
process_receiver_idAdd unique receiver IDs to passive acoustic telemetry time...
process_surfaceProcess a Raster* by aggregation and quantify the error...
query_open_topoQuery the Open Topo Data API for elevation data
round_anyRound to multiple of any number
segments_cross_barrierDetermine if Euclidean path segments cross a barrier
sim_arraySimulate (marine) monitoring arrays
sim_detectionsSimulate detections
sim_path_ou_1Simulate discrete-time movement paths under a...
sim_path_saSimulate discrete-time movement paths from step lengths and...
sim_path_-timesFunctions for the simulation of movement paths
sim_surfacePopulate a raster with simulated values
split_raster_equallySplit a raster into equal-area parts
summarise_along_walkSummarise every n numbers in a vector
update_extentShrink or expand an 'extent' object
xy_from_clickGet location coordinates from mouse click(s)
edwardlavender/flapper documentation built on Jan. 22, 2025, 2:44 p.m.