Next: listbrief() Up: MacAnova Help File Previous: lineplot()   Contents

list()

Usage:
list([invis:T]) or list(var1 [, var2, ...])
list([all:T, real:T or F, char:T or F, logic:T or F, macro:T or F,\
  struct:T or F, null:T or F, labeled:T or F, notes:T or F,\
  locked:T or F, keep:T, nrows:n1, ncols:n2, ndims:n3]); use F's only
  with all:T, n1, n2, n3 > 0 integers



Keywords: general
                                  Usage
list() lists the name, type, and dimensions of all currently active
variables, including structures and macros, but excluding any temporary
or "invisible" variables (variables whose names start with '_').  The
maximum level of any factors is printed.  See factor() and topic
'variables:"invisible"'..

list(invis:T) does the same, but also includes temporary variables and
invisible variables.

list(var1, var2, ..., vark) gives the same information only for the
specified variables.

For a macro, list() also prints 'out-of-line' or 'in-line' depending on
whether or not it has been marked to be expanded out-of-line.  See
topics 'macros', macro().

For any variable, list() may also print any or all of 'labels', 'notes'
or 'locked' depending on whether the variable has dimension lables,
attached notes or is locked.  See topics 'labels', 'notes', 'locks'.

                          Listing by attributes
list(size:T [,invis:T]) or list(var1,var2,...,vark,size:T) also lists
the total size of each variable in bytes.  In addition to the memory
required for data in a variable, this total includes a fixed amount (172
bytes in one Linux implementation) for each symbol and each structure
component.  In addition, MacAnova prints the total size of all listed
variables and the total of all memory currently used by MacAnova for
variable and internal storage.

list(varType:T [,invis:T]) where varType is one of 'real', 'factor',
'logic', 'char', 'macro', 'struc', or 'null' specifies that all
variables of the specified types are listed.  More than one keyword
phrase can appear but no variable names.  For example, list(real:T,
logic:T) will list all variables of type REAL or LOGICAL and
list(factor:T) will list all variables that are factors.

list(all:T,varType1:F [,varType2:F...] [,invis:T]) lists all types
except those specified.  For example, list(all:T,macros:F) lists all
objects except macros.

list(notes:T [,invis:T]) limits the listing to variables with notes.
See topic 'notes'.

list(labeled:T [,invis:T]) limits the listing to variables with labels.
See topic 'labels'.

list(locked:T [,invis:T) limits the listing to variables that are
locked.  See topic 'locks'.

list(nrows:r [,...]) lists all REAL, CHARACTER or LOGICAL variables with
first dimension r.

list(ncols:c [,...]) lists all REAL, CHARACTER or LOGICAL with second
dimension c.  When c = 1, vectors are also listed.  'nrows:r' and
'ncols:c' can be used together.

list(ndims:d [,...]) all REAL, CHARACTER or LOGICAL variables with
exactly d dimensions.  For example, list(ndims:1) lists all vectors.

Keywords 'nrows', 'ncols' and 'ndims' can be used together with
'char:T', 'real:T', or 'logic:T' to limit which variables are listed.

Keywords phrases 'labeled:T', 'notes:T' and 'locked:T' can be used
together with type and shape specifying keywords.  They suppress listing
variables that do not meet the additional restrictions.

                            Wildcard matching
list(Pattern ... [,invis:T]), where Pattern is a quoted string (but not
a CHARACTER variable) which contains one or more of the "wild card"
characters '*' and '?', lists only objects whose names match Pattern.

'*' will match any set of 0 or more consecutive characters of variable
names, and '?' will match any single character.

For example, list("x*") lists all variables whose names start with 'x',
list("*length") lists all variables whose names end in 'length', and
list("c*b???") lists all variables whose names start with 'c' and end
with 'b' followed by any 3 characters, say, "crybaby".  The last does
not match "crybabies", although "c*b???*" would.

list(pat:Pattern ... [,invis:T]) does the same, except Pattern may bea
CHARACTER scalar whose value is a pattern containing wild card
characters, not just a quoted string.

If a variable is "special" the type is preceded by '*'.  Currently the
only special variables are CLIPBOARD, SELECTION (GTK only) and
GRAPHWINDOWS.  See topics 'CLIPBOARD', 'GRAPHWINDOWS' and
'graph_assign'..

                        Examples of wildcard use
Examples:
  Cmd> list("*plot") # lists colplot but not plot1 or myplots
  Cmd> list("plot*") # lists plot1 but not colplot or myplots
  Cmd> list("*plot*") # lists all three.

                             Keyword 'keep'
list(...,keep:T [,invis:T]) suppresses the listing, but returns a
CHARACTER vector containing the names of the variables that would
otherwise have been listed; no information on type or dimensions is
returned.

                      Examples of selective listing
Example:
  Cmd> list("a*", real:T) # or list(pat:"a*", real:T)
will list all REAL variables whose names start with "a".

                            Cross references
See also delete(), listbrief(), dim().


Gary Oehlert 2005-08-12