/
README.Rmd
131 lines (70 loc) · 6.61 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
---
title: "rPraat package for R"
output: md_document
---
# rPraat package for R
rPraat package for R constitutes an interface between the most popular software for phonetic analyses, Praat, and R.
Version 1.3.2-1
For demonstration, see [html/rDemo.html](https://fu.ff.cuni.cz/praat/rDemo.html)
Package documentation [https://github.com/bbTomas/rPraat/blob/master/rPraat.pdf](https://github.com/bbTomas/rPraat/blob/master/rPraat.pdf)
CRAN link: [https://CRAN.R-project.org/package=rPraat](https://CRAN.R-project.org/package=rPraat)
See also: [mPraat toolbox](https://github.com/bbTomas/mPraat) for Matlab.
rPraat and mPraat homepage: [https://fu.ff.cuni.cz/praat/](https://fu.ff.cuni.cz/praat/)
## Installation
One-time installation (internet connection needed).
#### CRAN: official version
```{r, eval=FALSE}
install.packages("rPraat")
```
#### GitHub: experimental, most recent version
```{r, eval=FALSE}
install.packages("devtools")
devtools::install_github("bbTomas/rPraat")
```
### Initialize and Test
At each R session, you have to initialize the package (no internet needed).
```{r, eval=FALSE}
library(rPraat)
library(dplyr) # optional, if you want to use the pipeline operator %>%
tg.sample() %>% tg.plot() # demo test
```
## How to cite this package?
We have invested a lot of time and effort in creating mPraat toolbox / rPraat package, please cite it when using it for data analysis.
> Bořil, T., & Skarnitzl, R. (2016). Tools rPraat and mPraat. In P. Sojka, A. Horák, I. Kopeček, & K. Pala (Eds.), Text, Speech, and Dialogue (pp. 367–374). Springer International Publishing.
[Download Tools rPraat and mPraat manuscript .pdf](https://fu.ff.cuni.cz/praat/boril_skarnitzl_2016_Tools_rPraat_and_mPraat_[manuscript].pdf)
The final publication is available at Springer via [DOI 10.1007/978-3-319-45510-5_42](https://dx.doi.org/10.1007/978-3-319-45510-5_42)
[Download BibTeX reference mpraatrpraat2016.bib](https://fu.ff.cuni.cz/praat/mpraatrpraat2016.bib)
## What is new
v1.3.2-1 (2021/02/27): pitch.read(), formant.read() fix to new Praat text formats
v1.3.2 (2021/01/28): pt., it., pitch., formant., snd. getPointIndexHigherThanTime(), getPointIndexLowerThanTime(), getPointIndexNearestTime()
v1.3.1-1 (2020/04/04): formant.read(), formant.write(), pitch.read(), pitch.write(): better handling of --undefined-- values
v1.3.1 (2020/04/04): tg.plot(): can plot formant and pitch objects in frame and array formats
v1.3 (2019/12/04): tg.boundaryMagnet(): align interval boundaries in a target tier according to a pattern tier
v1.2.0-3 (2019/04/27): if "UTF-8" encoding is specified in .read() functions (i.e., default value) and input file cannot be read properly, then "auto" encoding is tried automatically with a warning message notification
v1.2.0-2 (2019/04/01): "UTF-16" TextGrids are properly saved in "UTF-8"
v1.2.0-1 (2019/03/16): detectEncoding(): removed "UTF-16LE" (does not work anymore), tg.read(fileName, encoding = "auto") works again
v1.2.0 (2018/12/08): pitch.write(), formant.write(), col.write()
v1.1.4 (2018/12/08): pitch.cut(), formant.cut(), snd.cut(); pitch.cut0(), formant.cut0(), snd.cut0()
v1.1.3-4 (2018/12/03): snd.read(), snd.write(), snd.plot(), as.snd(); tg.plot() can plot TextGrid together with Sound object; it.plot() can plot IntensityTier together with Sound object
v1.1.3-3 (2018/12/03): formant.toFrame(), pitch.toArray(), pitch.toFrame(), pitch.plot(); tg.plot() can plot TextGrid together with Pitch object; pitch.plot() can plot Pitch object together with PitchTier
v1.1.3-2 (2018/10/29): formant.plot(), formant.toArray(); tg.plot() can plot TextGrid together with Formant object
v1.1.3-1 (2018/10/26): tg.plot() can plot TextGrid together with PitchTier and IntensityTier in one plot
v1.1.3 (2018/10/20): formant.read(), formant.sample(), as.formant(); col.read() can read formant objects
v1.1.2-1 (2018/10/20): tg.plot(): right-aligned labels; pitch.sample(), as.tg(), as.pt(), as.it(), as.pitch(); .read(), .sample() and tg.createNewTextGrid(): class(object)["type"] set to "TextGrid", "PitchTier" etc. and class(object)["name"] set according to fileName
v1.1.2 (2018/08/04): tg.cut(), tg.cut0()
v1.1.1 (2018/08/02): IntensityTiers: it.read(), it.write(), it.plot(), it.sample(), it.interpolate(), it.cut(), it.cut0(), it.legendre(), it.legendreDemo(), it.legendreSynth(), col.read() supports IntensityTiers
v1.1.0 (2018/08/01): col.read() to read Collection in Text and Short-text format (Collection may store many objects in one file – TextGrids, PitchTiers, Pitch objects). Big thanks to Pol van Rijn for initiating this and making the major portion of the new code in mPraat toolbox. Supports for file encodings in all read functions (thanks to Weirong Chen for his DetectEncoding idea in mPraat toolbox).
v1.0.8-3 (2017/11/27): tg.write(): fix for possible UTF-8 encoding and Windows OS locale mismatch
v1.0.8-2 (2017/11/04): tg.write() and pt.write() format support: "text" (full text format), "short" (short text format), and in addition for pt: "spreadsheet" and "headerless"; tg.read(), pt.read() and pitch.read(): optional file encoding parameter (default: "UTF-8")
v1.0.8-1 (2017/09/01): bugfix, short-text TextGrid with multiple lines in a label no longer produces "missing sppasFormat variable" error
v1.0.8 (2017/07/16): pitch.read() to read Pitch-object files with time frames of pitch candidates
v1.0.7 (2017/04/19): tg.findLabels(), tg.duplicateTierMergeSegments()
v1.0.6 (2017/04/11): pt.cut(), pt.cut0()
v1.0.5 (2017/04/10): pt.legendre(), pt.legendreSynth(), pt.legendreDemo()
v1.0.4 (2017/03/06): pt.interpolate(), pt.Hz2ST()
## License
License: MIT
Copyright (c) 2016 Tomáš Bořil, borilt@gmail.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.