process_adcp: Master processing function for ADCP data

View source: R/process.R

process_adcpR Documentation

Master processing function for ADCP data

Description

Function takes in a filepath to a folder containing the cruise adcp files, reads them in, combines them into one data object and then exports to a comma-separated-file and an odv text file.

Usage

process_adcp(
  adcp_folder,
  cruiseID = NULL,
  csv_folder = "output/csv",
  csv_filename = "adcp.csv",
  odv_folder = "output/odv/adcp",
  odv_filename = "adcp.txt",
  add_cruiseID = TRUE,
  ...
)

Arguments

adcp_folder

filepath to the folder containing adcp files

cruiseID

Optional string specifying cruise ID (i.e. "S301")

csv_folder

The directory path to output the csv file. Set to NULL for no csv output.

csv_filename

The csv filename to output the data

odv_folder

The directory path to output the odv file. Set to NULL for no odv output.

odv_filename

The odv .txt filename to output the data

...

option arguments to be passed to read_adcp_fold(). A few options, but most likely is the file_type which defaults to '.LTA' (long term averages), but can be changed to ".STA" if you want to read in the short term averages

add_cruise_ID

If cruiseID is set, logical to specify whether cruiseID should be appended to beginning of filenames for csv and odv output

Details

Most likely optional arguments to go in for ...


benharden27/seaprocess documentation built on June 28, 2023, 7:20 p.m.