read.hs7.outputs: Read Heat Source 7 outputs.

View source: R/read.hs7.outputs.R

read.hs7.outputsR Documentation

Read Heat Source 7 outputs.

Description

Read hourly xlsm output from Heat Source version 7. Heat Source excel workbook needs to be saved as .xlsm. Workbooks in .xls do not work.

Usage

read.hs7.outputs(output_dir, file_name, sheet_name)

Arguments

output_dir

The path to directory where the Heat Source 7 .xlsm model is located.

file_name

The file name of the .xlsm Heat Source 7 model. The ".xlsm" extension should be included in the file name.

sheet_name

The name of the output worksheet to read.

Details

Data is returned in wide format with the model stream km used as the column name for all values. An "X" is added as a prefix to every stream km value to have syntactically valid column names. The datetime is the first column and is formatted in excel numeric date format.

This function reads the following output sheets:

  • Output - Solar Potential

  • Output - Solar Surface

  • Output - Solar Received

  • Output - Conduction

  • Output - Longwave

  • Output - Convection

  • Output - Evaporation

  • Output - Total Heat

  • Output - Evaporation Rate

  • Output - Temperature

To read heat source 7 effective shade outputs use read.hs7.shade.

Value

dataframe


DEQrmichie/heatsourcetools documentation built on Jan. 25, 2025, 2:31 p.m.