Skip to content

Commit

Permalink
Doc fixes?
Browse files Browse the repository at this point in the history
  • Loading branch information
mmcauliffe committed Feb 25, 2015
1 parent 8349e24 commit ec98173
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions corpustools/freqalt/freq_of_alt.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,28 @@ def calc_freq_of_alt(corpus, s1, s2, relator_type, count_what,
Parameters
----------
s1: char
A sound segment, e.g. 's', 't',
A sound segment, e.g. 's', 't'
s2: char
A sound segment
relator_type: string
The type of relator to be used to measure relatedness, e.g. 'string_similarity'
The type of relator to be used to measure relatedness, e.g.
'string_similarity'
sequence_type: string
The type of segments to be used ('spelling' = roman letters, 'transcription' = IPA symbols)
The type of segments to be used ('spelling' = roman letters,
'transcription' = IPA symbols)
count_what: string
The type of frequency, either 'type' or 'token'
max_rel: double
Filters out all words that are higher than max_rel from a relatedness measure
min_rel: double
Filters out all words that are lower than min_rel from a relatedness measure
phono_align: boolean (1 or 0), optional
1 means 'only count alternations that are likely phonologically aligned,' defaults to not force phonological alignment
1 means 'only count alternations that are likely phonologically aligned,'
defaults to not force phonological alignment
min_pairs_okay: boolean (1 or 0), optional
1 means allow minimal pairs (e.g. in English, 's' and 'ʃ' do not alternate in minimal pairs, i.e. diss/dish is not an alternation, so allowing minimal pairs may skew results)
1 means allow minimal pairs (e.g. in English, 's' and 't' do not
alternate in minimal pairs,
so allowing minimal pairs may skew results)
Returns
-------
Expand Down

0 comments on commit ec98173

Please sign in to comment.