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

Description Usage Arguments Value Note See Also Examples

Examine a metadata field of STAR objects.

1	peek(x, field = "Assessment_ID")

`x`	STAR object or a cluster (list) of STAR objects. Alternatively, `x` can be an Excel STAR template filename or directory name.
`field`	a metadata field, by default "Assessment_ID".

Metadata field from STAR object(s).

This function is convenient to quickly examine a cluster (list) of STAR objects after importing many STAR templates. See example below.

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

gfcmSTAR-package gives an overview of the package.

## Not run: 

peek(star)
peek(star, "Scientific_Name")
peek(star, "Status_Fref")

peek(star)         # object
peek(cluster)      # cluster
peek("STAR.xlsx")  # file
peek("folder")     # dir

## End(Not run)