LTPDA Toolbox™ contents Method: matrix/iplot   Method: matrix/save

Method matrix/report

  REPORT generates an HTML report about the input objects.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: REPORT generates an HTML report about the input objects.
 
  CALL:        report(objs);
               report(objs, options);
 
  INPUTS:      objs    - LTPDA objects
               options - a plist of options
 
  PARAMETERS:
               'dir'     - report dir [default: <temp dir>/ltpda_report/<date><time>]
               'extras'  - true [default] or false: plot data and diagrams
                           for objects, output mfile, and type() output.
               'desc'    - give a description to appear on the main report
                           page.
               'save'    - include saved versions of the objects in the
                           report directory. Objects are saved as XML.
                           Specify with true or false [default]
               'zip'     - compress the report directory to a ZIP file
               'plots'   - specify a cell-array of objects to build
                           plots on the main page. Each cell gets its
                           own plot. Example: {[a1, a3], {a5}}.
               'overwrite' - overwrite the report directory if it exists.
                             Specify true or false [default].
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ltpda_uoh
Sealed 0
Static 0

Parameter Description

Sets for this method …
Default

Default
no description
Key Default Value Options Description
report
DIR '' none
EXTRAS 1 none
DESC '' none
SAVE 0 none
ZIP 0 none
PLOTS {} [0x0] none
OVERWRITE 0 none

Example
plist('DIR', '', 'EXTRAS', [true], 'DESC', '', 'SAVE', [false], 'ZIP', [false], 'PLOTS', cell(0,0), 'OVERWRITE', [false])

back to top back to top

Some information of the method ltpda_uoh/report are listed below:
Class name ltpda_uoh
Method name report
Category Output
Package name ltpda
VCS Version 967b0eec0dece803a81af8ef54ad2f8c784b20b2
Min input args 1
Max input args -1
Min output args 0
Max output args -1
Can be used as modifier 0
Supported numeric types {'double'}



Method: matrix/iplot  Method: matrix/iplot   Method: matrix/save Method: matrix/save

©LTP Team