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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file fave_recode-0.3.0.tar.gz.

File metadata

  • Download URL: fave_recode-0.3.0.tar.gz
  • Upload date:
  • Size: 24.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.10.7 Darwin/23.2.0

File hashes

Hashes for fave_recode-0.3.0.tar.gz
Algorithm Hash digest
SHA256 357c2b0d93c815116d57d7f5ace2969d8925d826f8ef5f0b90f4a8d1f0831742
MD5 527ed3be3085cd4bf2022c145bcaed50
BLAKE2b-256 6d97aa2d5c12d258f3663d601c1dce717974a6d209089c42b600a1cbd9ec9e27

See more details on using hashes here.

File details

Details for the file fave_recode-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: fave_recode-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 25.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.10.7 Darwin/23.2.0

File hashes

Hashes for fave_recode-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 68479afe1c736775fc7731741c4adb2f4e0345fc7b1462a5b612fa89162592f5
MD5 90aebb7b20011beaa45be070ccc39c73
BLAKE2b-256 f1741737983c161653603fdeffa0b3a2b60fb1cdccd10698decb128cd3a0097e

See more details on using hashes here.

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