Segments NARWC line-transect survey data for distance sampling and density surface models (Distance, dsm).
Input format: Kenney, R.D. (2023) The North Atlantic Right Whale Consortium Database: A Guide for Users and Contributors, Version 8. Handbook (PDF).
Example data
path <- system.file("extdata", "narwc-example.csv", package = "distsamp")Synthetic. No real NARWC records are included.
Read
library(distsamp)
dat <- read_narwc(path)Prepare
dat <- prepare_survey(dat, platform = "aerial")Builds line occupations, fills LEGSTAGE, filters by platform, flags effort.
Check
validate_narwc(dat)
diagnose_pipeline(dat, seg_length = 5)
plot_survey(dat, "occupations")Segment
segs <- segment_survey(dat, seg_length = 5, seed = 1)
segs$segments # one row per segment
segs$detections # one row per sighting, with distance
segments_wide(segs)
plot(segs, what = "segments")seed makes the segmentation reproducible.
Detection table
flat <- detection_data(segs, area = 5811) # area in km^2Fit
Full steps to an abundance estimate: docs/11-distance-sampling-steps.md.
Shipboard surveys
sea <- prepare_survey(dat, platform = "vessel")
segs <- segment_survey(sea, seg_length = 10, platform = "vessel", seed = 1)
platform_defaults("vessel")Other functions
narwc_codes("LEGTYPE") # handbook code books
filter_days(dat, years = 2024) # subset by date
dist_methods() # along-track distance formulasCode layout
Pipeline scripts in R/ are numbered in the order they are used, from 00-reexports.R (reading) to 13-detection-data.R (the Distance table). 12-segment-survey.R runs steps 01 to 11. Unnumbered files are checks, plotting and helpers. See docs/10-code-guide.md.
Documentation
| Topic | File |
|---|---|
| Analysis steps | docs/11-distance-sampling-steps.md |
| Code guide | docs/10-code-guide.md |
| New dataset | docs/08-onboarding-a-real-extract.md |
| Shipboard surveys | docs/09-shipboard-surveys.md |
| Defects fixed from original code | docs/03-bug-fixes.md |
| References | docs/06-references.md |
| All documents | docs/README.md |
Citing distsamp
citation("distsamp")Returns the package, the segmentation method (Becker et al. 2010) and the data format (Kenney 2023). Report the seed used.
References
All sources, and what each is relied on for: docs/06-references.md.