pageList: Function to obtain a list of the registered variables of the...

View source: R/pageList.R

pageListR Documentation

Function to obtain a list of the registered variables of the current session.

Description

When your current session has registered shared memory variables via registerVariables internally the variable is tracked until it is released via releaseVariables.

This function serves as a tool to check whether all variables have been free'd after usage or to see what variables are currently held by the session.

Usage

  pageList()

Details

The string of each element of the output list has the format environment, backslash, backslash <namespace name>.<variable name>. Default is lokal environment.

Value

An [1:m] list of characters of the registered p namespaces, each of them having up to k variables, m<=p*k. Each element of the list is a combination of namespace and variable name

Note

Use alongside viewList to ensure all views and pages are cleared before shutdown.

Author(s)

Julian Maerte

See Also

viewList, registerVariables, releaseVariables

Examples

  pageList()
  ## Not run: 
  # = list()
  
## End(Not run)
  mat = matrix(0,5,5)
  registerVariables("ns_pageL", list(mat=mat))
  pageList()
  ## Not run: 
  # = list("mat")
  
## End(Not run)
  releaseVariables("ns_pageL", c("mat"))
  pageList()
  ## Not run: 
  # = list()
  
## End(Not run)

memshare documentation built on Dec. 5, 2025, 9:07 a.m.