star.oddi: *Star Oddi* Data

View source: R/star.oddi.R

star.oddiR Documentation

Star Oddi Data

Description

Functions to read, manipulate and analyze star.oddi trawl acoustic monitoring probe data.

Usage

star.oddi(x, ...)

## Default S3 method:
star.oddi(x, ...)

Arguments

x

An star.oddi object, data file, survey year or keyword search term.

year

Numeric value specifying the survey or project year(s).

full.names

Logical value specifying whether to include file paths when searching for star.oddi data files.

header

star.oddi file header information to be assigned as metadata.

tow.id

Numeric value or character string specifying the ID corresponding to a particular tow sampling station.

offset

Numeric value specifying the offset time (in minutes) to include as a corrective in the data time stamps.

repeats

Logical value specifying whether to keep or average out data records with identical time stamps.

remove

Character string specifying keyword(s) which, if found in the data file or path, are removed from the search results.

Methods (by class)

  • star.oddi(default): Default star.oddi method. Create an star.oddi object.

Examples

# Star Oddi files for the 2020 snow crab survey:
locate.star.oddi(year = 2020)

# Locate files with a specific tow ID from snow crab survey 2018-2020:
locate.star.oddi("GP001", year = 2018:2020)

# Working example:
x <- read.star.oddi(2018, tow.id = "GP354")
describe(x)  # Description of file contents.
header(x)    # File header information.
plot(x)      # Graphical summary.
summary(x)   # Data summary.

TobieSurette/gulf.data documentation built on Jan. 19, 2025, 7:50 p.m.