prepAttains: Prepares rolled up AU-Use and AU-Use-Parameter assessments...

View source: R/prepAttains.R

prepAttainsR Documentation

Prepares rolled up AU-Use and AU-Use-Parameter assessments for ATTAINS upload

Description

Prepares rolled up AU-Use and AU-Use-Parameter assessments for ATTAINS upload

Usage

prepAttains(
  current_assessment,
  trans_wb,
  pull_attains = TRUE,
  assess_path,
  param_path,
  last_reporting_cycle,
  current_reporting_cycle,
  filesave = TRUE
)

Arguments

current_assessment

A list of assessment output objects to be rolled up to the AU-use and (for cat 5 only) AU-use-parameter resolutions.

trans_wb

Excel workbook containing translation tables connecting irTools outputs to ATTAINS inputs. Currently resides in lookup tables repo.

pull_attains

Logical. If TRUE (default), function uses readAttains function from the irTools package to pull assessment data from the previous reporting cycle. If FALSE, param_path and assess_path are needed.

assess_path

File path to ATTAINS assessments.csv from previous reporting cycle.

param_path

File path to ATTAINS parameters.csv from previous reporting cycle.

last_reporting_cycle

Year of previous IR reporting cycle.

current_reporting_cycle

Year of current IR reporting cycle.

filesave

Logical. If TRUE (default), function saves AU-Use-Assessments and Category 5 AU-Use-Parameter Assessments to .csvs in a folder selected by the user.

Value

Returns a list consisting of two objects: AU-Use-Assessments for all AU's and Category 5 AU-Use-Parameter Assessments.


ut-ir-tools/irTools documentation built on Jan. 19, 2024, 6:55 p.m.