Source code for chaininglib.process.lexicon

import chaininglib.utils.dfops as dfops

# beware: just like chaininglib.utils.dfops, this file contains function operating on DataFrames.
# However the functions in this file aim to manipulate DataFrames with lexicon data, 
# whereas the functions in dfops are more general

def get_diamant_synonyms(df):    
    '''
    This function returns a set of synonyms for a lemma from a DiaMaNT result DataFrame. This is done by taking the definition text for entries which have been found by word form, and by taking the lemma for entries which have been found by definition text.
    
    Args:
        df: a Pandas DataFrame containing Diamant data
    Returns:
        a set of synonyms
        
    >>> lq = create_lexicon(lexicon).word(search_word).search()
    >>> df_lexicon = lq.kwic()
    >>> syns = diamant_get_synonyms(df_lexicon) 
    >>> display( 'Synoniemen voor ' + search_word + ': ' + ", ".join(syns)))
    
    '''
    
    dfops.check_valid_df("get_diamant_synonyms", df)
    
    # Depending on the result type, we return the lemma or the definition text
    lemmas = set(df[df["inputMode"]=="defText"]["n_ontolex_writtenRep"])
    defTexts = set(df[df["inputMode"]=="lemma"]["n_syndef_definitionText"])
    # Combine both sets
    return lemmas|defTexts