View source: R/mm_model_by_ply_prototype.R
mm_model_by_ply_prototype | R Documentation |
This function does nothing but has the proper form for a model_fun passed to
mm_model_by_ply
Other functions to be used as model_fun may
call inheritParams to use the parameter definitions given here.
mm_model_by_ply_prototype(
data_ply = v(mm_data(NULL)),
data_daily_ply = v(mm_data(NULL)),
day_start = NA,
day_end = NA,
ply_date = NA,
ply_validity = NA,
timestep_days = NA,
...
)
data_ply |
a data.frame containing all relevant, validated modeling data for a single ply of data. (1 ply ~= 1 date, although the day length has been specified by day_start and day_end and may not be exactly 24 hours) |
data_daily_ply |
NULL or a data.frame containing inputs with a daily timestep. |
day_start |
start time (inclusive) of a day's data in number of hours from the midnight that begins the date. For example, day_start=-1.5 indicates that data describing 2006-06-26 begin at 2006-06-25 22:30, or at the first observation time that occurs after that time if day_start doesn't fall exactly on an observation time. |
day_end |
end time (exclusive) of a day's data in number of hours from the midnight that begins the date. For example, day_end=30 indicates that data describing 2006-06-26 end at the last observation time that occurs before 2006-06-27 06:00. |
ply_date |
the modal date of this ply of data and data_daily, and the date by which this ply should be referred topresent. |
ply_validity |
the output of |
timestep_days |
numeric length of the mean timestep for this day, if
requested by setting |
... |
other args that were passed untouched from the function calling mm_model_by_ply, through mm_model_by_ply, and finally to this function. |
mm_model_by_ply_prototype()
mm_model_by_ply_prototype(extra_arg=7:12)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.