Polytransform: Difference between revisions
imported>Donal No edit summary |
imported>Donal No edit summary |
||
| Line 6: | Line 6: | ||
:[xout, model] = polytransform(x, options); | :[xout, model] = polytransform(x, options); | ||
:[xout] = polytransform(x, model); | |||
===Description=== | ===Description=== | ||
| Line 20: | Line 21: | ||
* '''xout''' = The augmented dataset or matrix. | * '''xout''' = The augmented dataset or matrix. | ||
* '''model''' = A standard model structure with ''modeltype = polytransform''. | * '''model''' = A standard model structure with ''modeltype = polytransform''. This model can be used to augment new data in the same way as the original data was augmented, using the same options, including preprocessing. | ||
===Options=== | ===Options=== | ||
| Line 38: | Line 39: | ||
If x is a 100 by 5 matrix, options are default, except for the squares option: | If x is a 100 by 5 matrix, options are default, except for the squares option: | ||
<pre> | |||
popts = polytransform('options'); | popts = polytransform('options'); | ||
popts.squares = 'on'; | |||
[xout, model] = polytrnasform(x,popts) | |||
</pre> | |||
gives the 100 by 10 matrix where the columns 6 to 10 are the squares of the first five. | gives the 100 by 10 matrix where the columns 6 to 10 are the squares of the first five. | ||
===See Also=== | ===See Also=== | ||
Revision as of 14:02, 27 September 2010
Purpose
Add new variables to a dataset object or matrix formed as power transforms and cross terms of the original variables.
Synopsis
- [xout, model] = polytransform(x, options);
- [xout] = polytransform(x, model);
Description
Add polynomial and cross terms to data matrix or dataset. Input dataset x has new transformed variables added. These can include existing variables raised to second, third, fourth power, or second order product of variables. The data can be preprocessed before transformed variables are calculated. preprocessingtype option specifies the type of preprocessing to apply, 'none', 'mncn', 'auto', or 'custom'. If 'custom' is specified then the 'preprocessing' option must be a valid preprocessing structure. If pca = 'on' the data are converted to PCA scores after preprocessing, but before the transformed variables are calculated.
Inputs
- x = Dataset or matrix to be augmented by the addition of transformed variables.
Outputs
- xout = The augmented dataset or matrix.
- model = A standard model structure with modeltype = polytransform. This model can be used to augment new data in the same way as the original data was augmented, using the same options, including preprocessing.
Options
options is a structure array with the following fields:
- squares: [ 'on' | {'off'} ], governs level of display,
- cubes: [ 'on' | {'off'} ], governs level of display,
- quadratics: [ 'on' | {'off'} ], governs level of display,
- crossterms: [ 'on' | {'off'} ], governs level of display,
- preprocessingtype: ['none' | 'mncn' | {'auto'} | 'pcrtile' | 'custom'], governs data preprocessing behavior,
- preprocessing: A preprocessing structure which is used if preprocessingtype = custom,
- pca: [ 'on' | {'off'} ], governs whether PCA is applied to the preprocessed data before transformed terms are calculated,
- maxpcs: Integer indicating how many PCs to use if pca = on,
- preprocessoriginalvars: [ 0| {1} ], governs whether the original variables are returned preprocessed or raw.
Examples
If x is a 100 by 5 matrix, options are default, except for the squares option:
popts = polytransform('options');
popts.squares = 'on';
[xout, model] = polytrnasform(x,popts)
gives the 100 by 10 matrix where the columns 6 to 10 are the squares of the first five.