Lexical Optimisation and Hardware-Timed Experiment Generation


[Up] [Top]

Documentation for package ‘lexsync’ version 0.1.0

Help Pages

add_bigram_frequency Mean bigram probability (type-based, non-positional), a phonotactic-probability proxy
add_neighbourhood Compute orthographic-neighbourhood dimensions (Coltheart's N and OLD20)
add_pair_overlap Orthographic overlap between the two members of each pair
assign_triggers Assign EEG trigger codes to stimuli
balance_check Check that the levels of given columns occur equally often
balance_lists Assign item sets to counterbalancing lists so the lists match on the item dimensions
build_datasheet Assemble the materials datasheet for one design
build_lexdec_stimuli Assemble a word-vs-pseudoword lexical-decision set from a candidate pool
build_pool Build an experimental candidate pool by filtering a lexicon
cohens_d Cohen's d (pooled-SD standardised mean difference)
cohens_d_ci Cohen's d with a confidence interval, complementing the TOST verdict
counterbalance Assign stimuli to lists and a randomised, reproducible trial order
count_syllables Orthographic syllable estimate: the number of maximal vowel runs
describe_stimuli Per-group descriptive statistics for several dimensions
export_experiments Export all presentation targets (PsychoPy, OpenSesame, jsPsych)
export_jspsych Export a browser-runnable jsPsych experiment
export_opensesame Export a complete plain-text OpenSesame experiment
export_psychopy Export a runnable PsychoPy script that interprets the event sequence
fetch_corpus Download a CSV-format registered corpus into the cache
generate_pseudowords A length-matched pseudoword for each base word (byte-order processing)
lexsync_cache_dir Per-user cache directory for fetched corpora
list_corpora List the corpora known to the registry
load_items Load a paradigm item table (prime-target pairs, sentences, ...)
load_lexicon Load a lexicon from a CSV file
load_pool Load a supplied candidate pool of words and give it the matcher's dimensions
log_artefact Record a written artefact (path, rows, fingerprint) in the log
log_step Append a step to a run log
make_pseudoword The most bigram-plausible legal non-word at the smallest edit distance
match_report Build the full match-quality report
match_report_continuous Realised-control report for a continuous design
match_stimuli Match stimuli across conditions on several lexical dimensions
merge_norms Left-join a norm table (e.g. concreteness, age of acquisition, valence)
methods_paragraph A ready-to-adapt methods paragraph rendered from a datasheet
new_run_log Start a new run log
PARADIGMS The paradigm registry: default event sequences and required fields
participant_table Build a participant counterbalancing table
required_fields Trial fields a design needs present in its items (paradigm + events)
resample_stimuli Produce several disjoint matched item sets (items as a random factor)
resolve_events The design's trial event list: its own 'events', else its paradigm's
resolve_trial_timing Realise per-trial event durations onto the stimuli table
run_all Run the lexsync pipeline for every design configuration
run_pipeline Run the lexsync pipeline for one design
select_continuous_stimuli Select a set spanning a continuous predictor, holding controls constant
tost_equiv Two one-sided tests (TOST) of equivalence on a Cohen's d bound
variance_ratio Variance ratio: a distributional balance check
write_datasheet Write a datasheet to a JSON record and a Markdown rendering
write_run_log Write the run log to Markdown (and optionally JSON Lines)