Updatemod: Difference between revisions

Latest revision as of 08:24, 23 October 2013

Update model structure to be compatible with the current version.

umodl = updatemod(modl); %update post-v2.0.1c model

umodl = updatemod(modl,data); %update pre-v2.0.1c model

modl = the model to be updated.
data = the original data must be supplied if the model was created by a PLS_Toolbox version before 2.0.1c.

@@ Line 1: / Line 1: @@
 ===Purpose===
-Update model structure to be PLS_Toolbox 3.0 compatible.
+Update model structure to be compatible with the current version.
 ===Synopsis===
-:umodl = updatemod(modl,''data'')
+: umodl = updatemod(modl);        %update post-v2.0.1c model
+: umodl = updatemod(modl,data);   %update pre-v2.0.1c model
 ===Description===
-The input <tt>modl</tt> is any older-version PLS_Toolbox model to be updated to the current release version model.
+====Inputs====
-Optional input ''<tt>data</tt>'' is required if the model was constructed using a version older than Version 2.0.1c.
+* '''modl''' = the model to be updated.
+* '''data''' = the original data must be supplied if the model was created by a PLS_Toolbox version before 2.0.1c.
-The output is an updated model <tt>umodl</tt>.
+====Output====
+* '''umodl''' = an updated model.
-If the model is not valid (not updatable or invalid format), an error is thrown.
 ===See Also===
-[[analysis]], [[pca]], [[pcr]], [[pls]]
+[[analysis]], [[evrimodel]], [[pca]], [[pcr]], [[pls]]