packList: Pack a List with Objects

In PBSmodelling: GUI Tools Made Easy: Interact with Models and Explore Data

Pack a List with Objects

Description

Pack a list with existing objects using names only.

Usage

packList(stuff, target="PBSlist", value, penv=NULL, tenv=.PBSmodEnv)

Arguments

stuff	character – vector of object names
target	character – name of target list object
value	numeric|character – an optional explicit value to assign to stuff
penv	environment – source environment (default=parent) or user-specified environment where stuff resides
tenv	environment – target environment where target list exists or will be located

Details

A list object called target will be located in the tenv environment. The objects named in stuff and located in the penv environment will appear as named components within the list object target.

If an explicit value is specified, the function uses this value instead of looking for local objects. Essentially, stuff = value which is then packed into target.

Value

No value is returned

Note

The function determines the parent environment from within. This environment contains the objects from which the function copies to the target environment. Alternatively, the user can specify the environment where stuff resides.

Author(s)

Rowan Haigh, Program Head – Offshore Rockfish
Pacific Biological Station (PBS), Fisheries & Oceans Canada (DFO), Nanaimo BC
locus opus: Institute of Ocean Sciences (IOS), Sidney BC
Last modified Rd: 2019-03-12

See Also

In package PBSmodelling:
unpackList, readList, writeList
Accessor functions:
tget, tcall, tprint, and tput

Examples

local(envir=.PBSmodEnv,expr={
  fn = function() {
    alpha=rnorm(10)
    beta=letters
    gamma=mean
    delta=longley
    packList(c("alpha","beta","gamma","delta")) }
  fn(); tprint(PBSlist)
})

PBSmodelling documentation built on Nov. 9, 2023, 5:07 p.m.