Chunky docs

Chunky docs
Return to the main chunky page.

chunky-0.8.2-beta

Usage:

-h --help

Display this helpful document.

-w --warn

Print warnings on files files that have suspicious formatting. NOTE: This can be caused by many things (different ABC/hr programs, text file conversions, etc.) aside from tampering. Use twice to make it more picky. Note: the results from such files are still included in the final results unless they're otherwise invalid, e.g. they're unparseable or they're eliminated for ABX reasons.

-n --no-color

Don't colorize output.

-d --directory=DIR

Directory from which to pull test results which should contain a subdirectory for each sample. If not specified, search the current directory.

-r --ratings=PREFIX

Output ratings for all samples to PREFIX01.txt, PREFIX02.txt, etc. and averages to PREFIX.txt. The format is suitable for ANOVA analysis.

-R --ranks=PREFIX

Same as above, except output ranks instead of ratings. The ranks of the averages get output to PREFIX.txt (as opposed to the averages of the ranks).

-s --spreadsheet=FILE.csv

Output a nice fancy spreadsheet to FILE.csv (csv format - should be importable by any spreadsheet worth its salt).

-c --codecs=NUM,CODEC;NUM,CODEC...

Key for translating filenames to the corresponding codec names. For example, for Roberto's 64k test, you'd use: --codecs=1,MP3pro;2,Real;3,WMA;4,FhG_MP3;5,Lame_128... NOTE: Spaces in codec names will be honored, but may result in output unreadable by friedman.exe. Leading and trailing spaces will be stripped from codec names (which is handy for readability's sake).

-f --codec-file=FILE

Read the list of codecs from FILE. They can be formatted as above, or each codec can be on a separate line:

1, MP3pro
2, Real
...

-p --pval=VALUE

Require an ABX test with a pval <= VALUE if a result file contains a rating of the original file (i.e. they used the slider on the left instead of the right or vice versa). If a result file does not meet this condition, a warning is printed and the file is not included in the results.

-P --pval-all=VALUE

Same as above, but require all ratings to have the supplied pval; not just the incorrectly rated ones.

-t --trials=VALUE

Require a minimum number of ABX trials for incorrectly rated samples.

-T --trials-all=VALUE

Same as above, but for correct ratings as well.

-i --interactive

When encountering a problem file or one that doesn't meet ABX requirements, present a menu allowing the user to choose various options on how to handle it.

-o --sort

Order columns in output file in order of increasing average score. If this (or -O) is not specified, the codecs will be output in the same order as they appeared on the command line.

-O --sort-reverse

Same as above but in reverse order.

You can use -r, -R and -s together if you'd like. Names of files not conforming to the requirements of -p, -P, -m or -M will be displayed. Chunky is designed to be used to process _all_ result files from a listening test in a single step. By default, the current directory is searched. It (or the directory specified by -d) should contain one subdirectory for each sample. Some examples:

# Sort codecs by average rank and output spreadsheet, ratings and
# ranks files.  The current directory is assumed by default.
  chunky -o -s sheet -r ratings -R ranks -c \
            "1,MP3pro;2,Real;3,WMA;4,FhG;5,Lame_128;6,Nero;7,QT;8,Vorbis"

# Output spreadsheet, require an ABX pval of 0.01 or less if a
# reference file is given a rating.  Read the list of codecs from
# code_file.txt and search for result files in the directory
# 64kresults.
chunky --spreadheet=sheet --pval=0.01 -d 64kresults -f codec_file.txt

# Output ratings, require ALL test results to have an ABX pval of
# 5% or less and require at least 8 trials if the reference file
# was rated.  Print out lots of warnings on any parsing
# inconsistencies.
chunky -ww -r ratings -P 0.05 -t 8 -d "." \
  -c "1,MP3pro;2,Real;3,WMA;4,FhG;5,Lame_128;6,Nero;7,QT;8,Vorbis"

Some caveats -- some platforms seem to break if there are spaces in file names or directory names no matter how you quote/escape them. If the output is full of funny characters or is illegible, you don't support color, so specify -n. Use of -w or -ww is strongly recommended to detect tampered files.

If you have trouble using chunky, or think something about it sucks or is missing, please feel free to yell at <phong@phong.org>.