dycdtools (version 0.3.1)

plot_prof: Profile plot of simulated variable values vs. depth

Description

A post-processing function used to visualise model output in a profile graph.

Usage

plot_prof(
  sim = temp.interpolated,
  obs = obs.temp,
  sim.start = "2017-06-06",
  sim.end = "2020-02-29",
  plot.start = "2017-06-06",
  plot.end = "2020-02-29",
  xlabel = "Temperature C",
  min.depth = 0,
  max.depth,
  by.value,
  plot.save = FALSE,
  file_name,
  height = 11,
  width = 18
)

Arguments

sim

interpolated values of variable.

obs

observed values of variable.

sim.start, sim.end

the beginning and ending simulation dates for the intended DYRESM-CAEDYM model run. The date format must be "%Y-%m-%d".

plot.start, plot.end

the beginning and ending dates for the plotting purpose. The date format must be "%Y-%m-%d".

xlabel

the x axis label of the profile figure

min.depth, max.depth, by.value

minimum and maximum depth for the profile plot at the depth increment of by.value.

plot.save

if TRUE, the plot is saved with the "height","width", and "ppi" parameters.

file_name

the file path to save the generated profile figure

height, width

the height and width of the profile figure.

Value

a profile plot of sim~depth

Examples

# NOT RUN {
 var.values<-ext.output(dycd.output=system.file("extdata", "dysim.nc", package = "dycdtools"),
                       var.extract=c("TEMP"))

 for(i in 1:length(var.values)){
   expres<-paste0(names(var.values)[i],"<-data.frame(var.values[[",i,"]])")
   eval(parse(text=expres))
  }

# interpolate temperature for depths from 0 to 13 m at increment of 0.5 m
  temp.interpolated<-interpol(layerHeights = dyresmLAYER_HTS_Var,
                             var = dyresmTEMPTURE_Var,
                             min.dept = 0,max.dept = 13,by.value = 0.5)

 data(obs_temp)
# profile plot of temperature sim and obs
  plot_prof(sim=temp.interpolated,
            obs = obs_temp,
            sim.start="2017-06-06",
            sim.end="2017-06-15",
            plot.start="2017-06-06",
            plot.end="2017-06-15",
            xlabel = "Temperature \u00B0C",
            min.depth = 0,max.depth = 13,by.value = 0.5)

# }