Skip to main content

A package for recoding Praat TextGrids

Project description

Getting started with fave-recode

PyPI codecov Maintainability FAVE Python CI Build Docs DOI

The idea behind fave-recode is that no matter how much you may adjust the dictionary of a forced-aligner, you may still want to make programmatic changes to the output.

Installation

You can install fave-recode at your system’s command line with pip.

pip install fave-recode

Basic usage

Installation of the fave-recode python package makes the fave_recode executable, which can also be run at the command line. You can get help with --help

fave_recode --help
Usage: fave_recode [OPTIONS]

Inputs: [at least 1 required]
  File inputs. Either a single file with -i or a path with -p. Not both.
  -i, --input_file FILENAME  single input file
  -p, --input_path PATH      Path to a set of files

Outputs:
  -o, --output_file TEXT     An output file name
  -d, --output_dest PATH     An output directory

Other options:
  -a, --parser TEXT          Label set parser. Built in options are cmu_parser
  -s, --scheme TEXT          Recoding scheme. Built in options are cmu2labov
                             and cmu2phila  [required]
  -r, --recode_stem TEXT     Stem to append to recoded TextGrid file names
  -t, --target_tier TEXT     Target tier to recode
  --help                     Show this message and exit.

To recode a single file, you need to provide fave_recode with, minimally, the input file (the -i flag), and the recoding scheme (with the -s flag). There are a few default recoding schemes that come with fave_recode.

ls data
KY25A_1.TextGrid                 josef-fruehwald_speaker.TextGrid
fave_recode -i data/josef-fruehwald_speaker.TextGrid -s cmu2phila -a cmu_parser

ls data
KY25A_1.TextGrid
josef-fruehwald_speaker.TextGrid
josef-fruehwald_speaker_recoded.TextGrid

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fave_recode-0.3.0.tar.gz (24.4 kB view hashes)

Uploaded Source

Built Distribution

fave_recode-0.3.0-py3-none-any.whl (25.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page