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

In DEQrmichie/heatsourcetools: Heat Source Model Post Processing Tools

Read Heat Source 7 effective shade outputs.

Description

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

Usage

read.hs7.shade(
  output_dir,
  file_name,
  sheet_name = "Chart-Shade",
  date_correction = TRUE
)

Arguments

output_dir	The path to the directory where the Heat Source .xlsm is located.
file_name	The file name of the .xlsm heat source model. The ".xlsm" extension should be included in the file name.
sheet_name	The name of the output worksheet to read. Default is "Chart-Shade".
date_correction	TRUE or FALSE. If TRUE, subtracts one day to the date to correct a bug in Heat Source 7 where the date in the "Chart-Shade" worksheet was one one day off. Default is TRUE.

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 is setup to read the "Chart-Shade" worksheet.

Value

data frame

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