read.template.v10: Read STAR Template Version 1.0

In gfcm/gfcmSTAR: Tools to Work with GFCM Stock Assessment Results (STAR)

Description

Read the results found in an Excel STAR template version 1.0 into a STAR object.

Usage

read.template.v10(file, atype = "Standard", refyear = 2019,
  repyear = 2021, countries = NA, prop = NULL, suffix = "",
  quiet = TRUE)

Arguments

file	name of Excel file.
atype	assessment type, "Standard" or "Benchmark".
refyear	reference year.
repyear	reporting year.
countries	countries, separated by comma and space.
prop	SharePoint properties from read.properties.
suffix	optional string passed to combo to construct a unique Assessment_ID field.
quiet	whether to supress messages.

Value

STAR object, a list containing Metadata (simple list) and TimeSeries (data frame).

See Also

read.template calls read.template.v10 when the Excel STAR template is of version 1.0.

loadWorkbook and readTable are the underlying functions used to read data from Excel STAR templates.

read.properties reads SharePoint properties from an Excel file.

combo is used to construct the Assessment_ID metadata field.

gfcmSTAR-package gives an overview of the package.

Examples

## Not run: 

# Import
star <- read.template.v10("STAR_2019_HKE_5.xlsx")

## End(Not run)

gfcm/gfcmSTAR documentation built on Feb. 5, 2022, 2:14 p.m.