read_flake_out: Extract FLake output

View source: R/read_flake_out.R

read_flake_outR Documentation

Extract FLake output

Description

Read in FLake results, interpolate to a gridded struture and return a dataframe in long or wide format for vars = "temp"

Usage

read_flake_out(
  output,
  vars,
  depths,
  folder = ".",
  nml_file,
  long = FALSE,
  out_time,
  out_hour = 0
)

Arguments

output

filepath; to FLake output file

vars

vector; variables to extract from FLake output. Currently just temp and ice

depths

vector; of numeric values to extract the depths at. Only used if extracting water temp

folder

filepath; to folder which contains the model folders generated by export_config()

nml_file

filepath; to FLake namelist file

long

Boolean; return data in long form

out_time

vector; of output time values to subset data by.

out_hour

numeric; hour of output time values to subset data. Only used for FLake if model time step is 86400s.

Value

Dataframe if only one variable otherwise a list

Examples

## Not run: 
df <- read_flake_out(output = "FLake/output/output.dat", folder = "FLake", nml_file = "FLake/feeagh.nml")

## End(Not run)


aemon-j/LakeEnsemblR documentation built on April 11, 2025, 10:09 p.m.