read.template: Read STAR Template
In gfcm/gfcmSTAR: Tools to Work with GFCM Stock Assessment Results (STAR)

Description Usage Arguments Details Value Note See Also Examples

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

1	read.template(file, prop = NULL, suffix = "", quiet = TRUE, ...)

`file`	name of Excel file.
`prop`	SharePoint properties from `read.properties`.
`suffix`	optional string passed to `combo` to construct a unique `Assessment_ID` field.
`quiet`	whether to supress messages.
`...`	passed to version-specific functions, such as `read.template.v21`.

prop is required to provide metadata values for SharePoint_Folder, Person_Modified, and Time_Modified. If prop is not supplied, these metadata values will be NA.

suffix is required when there are stock assessments that have the same Reference Year, Species, and GSA. It is used to distinguish each assessment by appending the suffix with an underscore separator to create a unique Assessment_ID metadata field for the STAR object. See examples below.

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

The user can either use the general read.template function or version-specific functions, such as read.template.v21, to the same effect.

The Excel STAR templates have a version number that consists of three numbers: major.minor.patch. The major version is incremented when the STAR database design needs to be changed, the minor version when the R import function needs to be changed, and the patch version when changes are backwards compatible.

import.many.templates imports many Excel STAR templates from a directory into a cluster (list).

read.template.v10 reads an Excel STAR template of version 1.0 into a STAR object.

read.template.v21 reads an Excel STAR template of version 2.1 into a STAR object.

read.star.csv reads a pair of STAR CSV files into a STAR object.

read.properties reads SharePoint properties from an Excel file.

combo is used to construct the Assessment_ID metadata field.

template.version detects the STAR template version of an Excel file.

write.star.csv writes a STAR object to CSV files.

gfcmSTAR-package gives an overview of the package.

## Not run: 
star <- read.template("STAR_2019_HKE_5.xlsx")

# Passing a suffix
read.template("STAR_2019_HKE_5.xlsx")$Metadata$Assessment_ID
read.template("STAR_2019_HKE_5.xlsx", suffix="a4a")$Metadata$Assessment_ID
read.template("STAR_2019_HKE_5.xlsx", suffix="sam")$Metadata$Assessment_ID
read.template("STAR_2019_HKE_5.xlsx", suffix="something_special")

## End(Not run)