oceanTime_FindFile: Find the file in which an input ocean_time is bracketed

View source: R/oceanTime_FindFile.R

oceanTime_FindFileR Documentation

Find the file in which an input ocean_time is bracketed

Description

Function to find the file in which an input ocean_time is bracketed.

Usage

oceanTime_FindFile(
  ocean_time,
  dfr_files = NULL,
  path = "",
  pattern = "*.nc",
  ref = as.POSIXct("1900-01-01 00:00:00", tz = "GMT"),
  verbose = FALSE
)

Arguments

ocean_time

- time (in seconds relative to the calendar reference or as POSIXct date)

dfr_files

- dataframe with ocean times by file name (output from oceanTime_GetTimes)

path

- file path to folder with model output files

pattern

- pattern for model output filenames (e.g. "avg_*.nc")

ref

- calendar reference (default = "1900-01-01 00:00:00")

verbose

- flag to print extra information

Details

None.

Value

One-row dataframe with columns:

  • ot,input ocean time (s)

  • date,associated date

  • fn,Name of model output file in which the input ocean_time is bracketed.

  • ts,lefthand bracketing time slice in file

  • bracket, bracketing times


wStockhausen/wtsROMS documentation built on Feb. 2, 2025, 9:16 p.m.