DataFrame/with - Maple Programming Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : Statistics and Data Analysis : DataFrames and DataSeries : DataFrame Commands : DataFrame/with

DataFrame/with

simplify syntax for referring to DataFrame columns

DataFrame/unwith

remove DataFrame columns from global namespace

 

Calling Sequence

Parameters

Description

Examples

Compatibility

Calling Sequence

with(DF)

unwith(DF)

Parameters

DF

-

a DataFrame object

Description

• 

The with command, applied to a DataFrame object, makes columns of the DataFrame available as variables at the interactive level.

• 

The unwith command undoes the effects of prior calls to with.

• 

The with command is effective only at the top level, and intended primarily for interactive use.  Because with operates by using lexical scoping, it does not work inside the bodies of procedures, module definitions, or within statements.  See the Examples section below.

• 

DataFrames are collections of named columns of data called DataSeries. They are explained in more detail on the DataFrame help page.

• 

Only column labels that are symbols can be used as variables. Columns with labels that are not symbols (for example, indexed names or other algebraic expressions) are ignored by with.

• 

When with is called with a DataFrame as its argument, it binds the column names of the DataFrame to the global namespace.  This makes the column names available to the interactive user at the top level of the Maple interaction loop.

• 

The unwith command undoes the effects of prior calls to with. That is, when it is called with as its argument a DataFrame that was previously submitted to with, unwith unbinds the column names in the global namespace, any previous bindings of those names are restored.

• 

The restart command clears the Maple internal memory, clearing any bindings made by with.

• 

The with command is also used for making the exports of a package accessible in the global namespace. This use is explained on the with help page. This is different from using the command on a DataFrame object in several ways: the exports of a package are (typically) procedures, whereas the columns in a DataFrame for example, are not.

Examples

If you have defined a DataFrame df which has a column a, then to access that column (a DataSeries object), you must enter df[a].

dfDataFrame1|2,3|4,columns=a,b

dfab112234

(1)

df2DataFrame5|6,7|8,columns=a,c

df2ac156278

(2)

dfa

1123

(3)

a

a

(4)

However, after using the with(df) command, you can use the column name a directly, without specifying the DataFrame to which the column belongs.

withdf

a,b

(5)

a

1123

(6)

unwithdf

a

a

(7)

As illustrated in the previous example, a list of the column names bound to the top level is returned by with.

Sometimes a column name is identical to a top level name with a global meaning. Global names are still fully accessible.  To access the global name a after having bound a DataFrame that has a column named a, use the prefix form of the : operator, as in  :a .

For example, the variable a may be in use.

a12.3

a12.3

(8)

After issuing a call to with(df), in which the name a occurs as a column label, the name a now refers to a column of data. The original variable is still available by using the syntax :-a.

withdf

a,b

(9)

a

1123

(10)

:-a

12.3

(11)

In addition, two or more DataFrames may have columns with some of the same names. In this case, if both are bound using with, only the most recently bound value will be available at the top level by using a single variable name. In the following example, that is df2.

withdf2

a,c

(12)

a

1527

(13)

You can still refer to a column of any other DataFrame by naming the DataFrame it comes from, using syntax of the form df[':-a']. If you were to write just df[a], then the variable a would first evaluate to the corresponding column of df2, and df cannot infer which column is meant. This results in an error message. Using the syntax :-a makes sure that the global name a is used, not the column name from df2. In this case, that global name was assigned a value (namely, 12.3); we do not want :-a to evaluate to that value either: if it would, then df could still not infer which column is meant. In order to prevent :-a from evaluating, we use unevaluation quotes.

dfa

Error, (in DataFrame:-`?[]`) invalid row index into DataFrame: non-Boolean DataSeries

df:-a

Error, (in DataFrame:-`?[]`) invalid index (12.3) into DataFrame

df':-a'

1123

(14)

Compatibility

• 

The DataFrame/with and DataFrame/unwith commands were introduced in Maple 2016.

• 

For more information on Maple 2016 changes, see Updates in Maple 2016.

See Also

DataSeries/with

with