formatted(self,
useWord=True,
usePOS=True,
normalise=True,
threshold=-1,
showFirstX=-1,
decimalPlaces=4,
countOther=True,
showTotal=True)
| source code
|
Displays formatted concordance summary information.
This is a convenience method that combines raw() and display()'s
options. Unless you need raw output, this is probably the most useful
method.
- Parameters:
useWord (boolean) - Include the words in the count. Defaults to True.
usePOS (boolean) - Include the POS tags in the count. Defaults to False.
normalise (boolean) - If true, normalises the frequencies for each set of concordance
output by dividing each key's frequency by the total number of
samples in that concordances's FreqDist. Allows easier comparison
of results between data sets. Care must be taken when combining
this option with the threshold option, as any threshold of 1 or
more will prevent any output being displayed. Defaults to False.
threshold (number) - Frequency display threshold. Results below this frequency will
not be displayed. If less than 0, everything will be displayed.
Defaults to -1.
showFirstX (number) - Only show this many results, starting with the most frequent. If
less than 0, everything will be displayed. Defaults to -1.
decimalPlaces (integer) - Number of decimal places of accuracy to display. Used when
displaying non-integers with the normalise option. Defaults to 4.
countOther (boolean) - If true, any samples not shown (due to their frequency being
below the given thershold or because they were after the number
of results specified by the showFirstX argument) will be combined
into one sample. This sample's frequency is the sum of all
unshown sample's frequencies. Defaults to False.
showTotal (boolean) - If true, prints the sum of all frequencies (of the entire
FreqDist, not just of the samples displayed.) Defaults to False.
|