echoIBM.get.segfilename: Locates the path of an event specified by numeric or sting...

View source: R/echoIBM.get.segfilename.R

echoIBM.get.segfilenameR Documentation

Locates the path of an event specified by numeric or sting for both 'event' and 'cruise' (used in read.event()), and generates segmentation file names continuing from the extisting numbered segmentation files.

Description

Locates the path of an event specified by numeric or sting for both 'event' and 'cruise' (used in read.event()), and generates segmentation file names continuing from the extisting numbered segmentation files.

Usage

echoIBM.get.segfilename(
  n = 1,
  t = 0,
  nchart = NULL,
  event = 1,
  cruise = 2009116,
  esnm = "MS70",
  dir.data = NULL,
  add = "",
  startn = NULL
)

Arguments

n

is an integer giving the sequence number to append to the file name. If n = 3 and there are 4 segmentation files present, the numbers 5, 6, and 7 are added to the file names.

t

is the time step index to append to the file name.

nchart

is the number of characters of the time point information, defaulted to the maximum number of characters of 't'.

event

is the identifier of the event, either given as the number of the event, a string contained in the name of the event, or the path of the event directory.

cruise

is either the idenfication number of the cruise, given as specified by the IMR (yyyynnn), or the path to the directory containing the event to be read.

esnm

is the name of the acoustical instrument, given as a four character string. See sonR_implemented() for the implemented systems. May be given in 'data', and in lower case.

dir.data

is the path to the directory in which the projects are stored, defaulted by the variable Acoustics_datasets_directory().

add

is a string to add to the file name.

startn

is the start number of the files.


arnejohannesholmin/cpplot3d documentation built on April 14, 2024, 11:36 p.m.