thermopic_model: Fit Thermopic Model

Description Usage Arguments Value

View source: R/model.R

Description

Fit Thermopic Model

Usage

1
2
3
4
thermopic_model(path, Lake, Climate, Model_Inputs = "3_Model_Inputs.csv",
  STM_Parameters = "4_STM_Parameters.csv",
  tmp_ClimMetrics = "tmp_ClimMetrics.csv",
  tmp_IceClimMetrics = "tmp_IceClimMetrics.csv", year_fix = 2010)

Arguments

path

Character string containing the path to the root of a thermopic project

Lake

A data.frame or csv file with schema defined in section C4 of the ThermoPic Guide under the 1_Lake.csv sub-heading. If a csv file is used, please place it within the DataIn folder under the thermopic project in path.

Climate

A data.frame or csv file with schema defined in section C4 of the ThermoPic Guide under the 2_Climate.csv sub-heading. If a csv file is used, please place it within the DataIn folder under the thermopic project in path.

Model_Inputs

The name of an output csv file with schema defined in section C5 of the ThermoPic Guide under the 3_Model_Inputs.csv sub-heading. This file contains the inputs needed to calculate the STM parameters. They include lake measurements, as well as climate and ice variables.

STM_Parameters

The name of an output csv file with schema defined in section C5 of the ThermoPic Guide under the 4_STM_Parameters.csv sub-heading. This file contains estimates of the STM parameters which are used to predict temperature at depth throughout the icefree season. These estimates are needed to calculate seasonal thermal habitat. Editing of the columns Do_Space and Do_ThermoPic may be done to control output from thermopic_report

tmp_ClimMetrics

The name of an output temp file used mainly for debugging

tmp_IceClimMetrics

The name of an output temp file used mainly for debugging

year_fix

Integer giving a calender year for simplifing the code by assigning "year_fix" for calculating Day of Year and Solar elevation/angle. Exact year not needed because because program works with Temperature norms for Specified Period. Solar angle for a given day of year varies on 4 year cycle, but variation is very small.

Value

s3 object of class thermopic_model, containing the following output dataframes:

tmp_ClimMetrics

Modified climate table

tmp_IceClimMetrics

Table of ice climate metrics

Model_Inputs

Input variables needed to calculate the STM parameters

STM_Parameters

Estimates of the STM parameters used to predict temperature at depth throughout the icefree season


stevencarlislewalker/thermopic documentation built on March 10, 2020, 8:31 p.m.