Help Tips: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
(Importing text file)
imported>Jeremy
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
There are a variety of ways to get help in PLS_Toolbox. Aside from this help browser, you can also use the following commands at the Matlab command line:
There are a variety of ways to get help in PLS_Toolbox. Aside from this help browser, you can also use the following commands at the Matlab command line:
   
   
:"<''functionname''> demo" gives a demo to use the function.
:"<''functionname''> io" gives a short list of function I/O.
:"<''functionname''> help" gives a detailed help page for the function.
:"help <''functionname''>" gives short help on the function.
:"lookfor <''keyword''>" lists functions related to the specified keyword.
For help in working with I/O and options of functions, see [[Working With Function Options]]
   
   
<>Type "&lt;<em>functionname</em>&gt; demo" to see a short demo.&nbsp;&nbsp;&nbsp;<a desc="matlab:auto('demo')"><font size="-1">[example]</font></a>
(Sub topic of [[Getting_Started_Documentation_and_Help|Getting Started Documentation and Help]])
<>Type "&lt;<em>functionname</em>&gt; io" to get short list of function I/O.&nbsp;&nbsp;&nbsp;<a desc="matlab:auto('io')"><font size="-1">[example]</font></a>
<>Type "&lt;<em>functionname</em>&gt; help" to get extensive help.&nbsp;&nbsp;&nbsp;<a desc="matlab:auto('help')"><font size="-1">[example]</font></a>
<>Type "help &lt;<em>functionname</em>&gt;" to get short help. &nbsp;&nbsp;&nbsp;<a desc="matlab:help auto"><font size="-1">[example]</font></a>
<>Type "lookfor &lt;<em>keyword</em>&gt;" to find functions related to keyword.&nbsp;&nbsp;&nbsp;<a desc="matlab:lookfor('auto')"><font size="-1">[example]</font></a>
(Sub topic of [[Getting_Started_Documentation_and_Help|Getting_Started_Documentation_and_Help]])

Latest revision as of 15:53, 13 March 2012

There are a variety of ways to get help in PLS_Toolbox. Aside from this help browser, you can also use the following commands at the Matlab command line:

"<functionname> demo" gives a demo to use the function.
"<functionname> io" gives a short list of function I/O.
"<functionname> help" gives a detailed help page for the function.
"help <functionname>" gives short help on the function.
"lookfor <keyword>" lists functions related to the specified keyword.

For help in working with I/O and options of functions, see Working With Function Options

(Sub topic of Getting Started Documentation and Help)