--rmatrix

Switch

--rmatrix

Description

Dictates format of correlation output for --correlate — produces an HTML correlation matrix (and, with --csv, a csv version as well).

Argument and Default Value

No argument. Boolean switch, default: False.

Details

Without --rmatrix, --correlate output goes to stdout as a Python dict. With it, results are also written to <output_name>.html (and .csv if --csv is also given).

Other Switches

Required Switches:

Optional Switches:

Example Commands

Using the packaged dla_tutorial dataset (see Differential Language Analysis (DLA) Tutorial):

dlatkInterface.py -d dla_tutorial -t msgs -c user_id -f 'feat$1to3gram$msgs$user_id$0_05' \
--outcome_table blog_outcomes --outcomes age gender \
--output_name test_correlation --correlate --rmatrix --csv --sort