create_input_file: Create a FARSITE input file

Description Usage Arguments Value

Description

This function creates the contents for a FARSITE input file from a template (package file extdata/input_template.txt) and a set of values for variable components. Note that you should specify either the path to a file of RAWS-format weather data (via path.raws) or the paths to separate weather and wind files (path.wtr and path.wnd).

Usage

1
2
3
create_input_file(start.time, end.time, path.fms, weather.units, path.raws,
  raws.elev, path.wtr = NULL, path.wnd = NULL, path.fmd = NULL,
  path.ros.adj = NULL)

Arguments

start.time

Character string for start date and time, e.g. '08 28 0000'.

end.time

Character string for end date and time, e.g. '08 29 2359'.

path.fms

Path to a file of tabular data for fuel moisture in the six-column format expected by FARSITE. Note, only the data records should be included in the file without any header information.

weather.units

system of measurement for weather variables: either 'METRIC' or 'ENGLISH'.

path.raws

Path to a file of tabular RAWS weather data in the ten-column format expected by FARSITE. Note, only the data records should be included in the file without any header information.

raws.elev

Elevation of weather station that provided the RAWS data. This is ignored if path.raws is missing or NULL and weather data is provided as separate files for daily summary data (path.wtr) and wind data (path.wnd).

path.wtr

Path to a file of daily summary data for temperature, rainfall and humidity in the format expected by FARSITE. Ignored if path.raws is specified. Any comment lines or header lines are ignored. Units ("METRIC" or "ENGLISH") should be specified via the weather.units parameter.

path.fmd

Optional path to a custom fuels file.

path.ros.adj

Optional path to the ROS adjustment file.

path.wtr

Path to a file of hourly data for wind speed, wind direction and cloud cover in the format expected by FARSITE. Ignored if path.raws is specified. Any comment lines or header lines are ignored. Units ("METRIC" or "ENGLISH") should be specified via the weather.units parameter.

Value

Contents of the input file as a single character string.


mbedward/farsitebatch documentation built on May 8, 2019, 1:51 p.m.