-It is possible to change an output format in the `output_format` argument: by dafault it is "html", but you can use "pptx" (it is a new feature of `rmarkdown`, so update the package in case you get errors).
+It is also possible to change the output format, using the `output_format` argument. By dafault it is "html", but you can also use "pptx" (this is a relatively new feature of `rmarkdown`, so update the package in case you get errors).
## Rename collected data
-After collecting data and removing wrong soundfiles one could end up with the following structure:
+After collecting data and removing soundfiles with unsuccesful elicitations, one could end up with the following structure:
```{bash, echo = FALSE}
tree | tail -n 10 | head -n 8
```
-For each speaker `s1` and `s2` there is a folder that containes three audiofiles. Lets rename the files.
+For each speaker `s1` and `s2` there is a folder that containes three audiofiles. Now let's rename the files.
```{r}
rename_soundfiles(stimuli = my_stimuli_df$stimuli,
@@ -162,13 +162,13 @@ rename_soundfiles(stimuli = my_stimuli_df$stimuli,
path = "s1/")
```
-As a result one can obtain the following structure:
+As a result, you obtain the following structure:
```{bash, echo = FALSE}
tree | tail -n 14 | head -n 12
```
-The `rename_soundfiles()` function created a backup folder with all unrenamed files and renamed all files using `prefix` from `prefix` argument. There is an additional argument `backup` that could be set to `FALSE` (it is `TRUE` by default), in case you are sure that renaming function works properly with your files and stimuli.
+The `rename_soundfiles()` function created a backup folder with all of the unrenamed files, and renamed all files using the prefix provided in the `prefix` argument. There is an additional argument `backup` that can be set to `FALSE` (it is `TRUE` by default), in case you are sure that the renaming function will work properly with your files and stimuli, and you do not need a backup of the unrenamed files.
```{r}
rename_soundfiles(stimuli = my_stimuli_df$stimuli,
@@ -182,13 +182,13 @@ rename_soundfiles(stimuli = my_stimuli_df$stimuli,
tree | tail -n 14 | head -n 12
```
-The last command renamed soundfiles in `s2` folder adding prefix `s2` as in previous example, and adding suffix `1`-`3`. On most operational systems it is impossible to create two files with the same name, so sometimes it could be useful to add some kind of index at the end of the files.
+The last command renamed the soundfiles in the `s2` folder, adding the prefix `s2` as in the previous example, and the suffix `1`-`3`. On most operating systems it is impossible to create two files with the same name, so sometimes it can be useful to add some kind of index at the end of the files.
-For now `phonfieldwork` can work only with `.wav` files, but I will try to implement more possibilities in the future (such as ELAN .eaf and EXMARaLDA ...).
+For now `phonfieldwork` works only with `.wav` files, but I will try to implement more possibilities in the future (such as ELAN .eaf and EXMARaLDA.exb).
## Merge all data together
-After all files are renamed, it is possible to merge them into one:
+After all the files are renamed, you can merge them into one:
```{r}
concatenate_soundfiles(file_name = "s1_all",
@@ -201,13 +201,13 @@ This comand creates a new soundfile `s1_all.wav` and an asociated Praat TextGrid
tree | tail -n 16 | head -n 14
```
-The result file could be parsed with Praat:
+The resulting file can be parsed with Praat:
![](images/01_concatenate_soundfiles_result.png)
## Annotate your data
-It is possible to create an annotation of words using existing annotation:
+It is possible to annotate words using an existing annotation:
```{r}
my_stimuli_df$stimuli
@@ -217,9 +217,9 @@ annotate_textgrid(annotation = my_stimuli_df$stimuli,
![](images/02_annotate_textgrid_result.png)
-As it could be seen from the example the `annotate_textgrid()` function creates a backup of the tier, and add a new tier on top of the previous one. It is possible to prevent this function of doing so, by setting a `backup` argument to `FALSE`.
+As you can see in the example, the `annotate_textgrid()` function creates a backup of the tier and adds a new tier on top of the previous one. It is possible to prevent the function from doing so by setting the `backup` argument to `FALSE`.
-It is possible to annotate every second (third, fourth etc.) interval. Imagine that somebody annotated each vowel in the recording, so the TextGrid will looks like the following:
+It is possible to annotate every second (third, fourth, etc.) interval. Imagine that someone annotated each vowel in the recording, so the TextGrid will look as follows:
```{r, include=FALSE}
annotation <- read.csv("annotation_of_s1.csv")
@@ -229,7 +229,7 @@ df_to_tier(df = annotation, textgrid = "s1/s1_all.TextGrid")
![](images/03_annotate_textgrid_result.png)
-So it is possible to use the second column in `my_stimuli_df` that contain vowels:
+Now you can use the second column in `my_stimuli_df`, which contains vowels.
```{r}
my_stimuli_df$vowel
@@ -241,16 +241,16 @@ annotate_textgrid(annotation = my_stimuli_df$vowel,
```
![](images/04_annotate_textgrid_result.png)
-From the last figure one can see that no backup tier was created (`backup = FALSE`), exactly the third tier was annotated (`tier = 3`), and annotation were performed in every second interval (`each = 2`).
+You can see from the last figure that no backup tier was created (`backup = FALSE`), that the third tier was annotated (`tier = 3`), and that an annotation was performed in every second interval (`each = 2`).
## Extracting your data
-First it is important to create a folder, where all extracted files will be stored:
+First, it is important to create a folder where all of the extracted files will be stored:
```{r}
dir.create("s1/s1_sounds")
```
-It is possible extract all annotated files according some annotation tier:
+It is possible extract to extract all annotated files based on an annotation tier:
```{r}
extract_intervals(file_name = "s1/s1_all.wav",
@@ -265,26 +265,26 @@ tree | tail -n 19 | head -n 17
```
-## Visualising your data
-It is possible to visualise an oscilogram and spetrogram of any sound file:
+## Visualizing your data
+It is possible to view an oscilogram and spetrogram of any soundfile:
```{r, fig.width=12, fig.height=6}
draw_sound(file_name = "s1/s1_sounds/1_s1_ı.wav")
```
-There are additional parametres:
+There are additional parameters:
-* `title` -- the title for the plot.
-* `colores` -- for color spectrogram (`TRUE`), for greyscale (`FALSE`). It is also possible to provide a vector of colors for creating the spectrogram.
-* `maximum_frequency` -- the maximum frequency to be displayed for the spectrogram.
-* `dynamic_range` -- values greater than this many dB below the maximum will be displayed in the same color.
-* `window_length` -- the desired analysis window length in milliseconds.
+* `title` -- the title for the plot
+* `colores` -- set to (`TRUE`) for a colored spectogram, or (`FALSE`) for greyscale. It is also possible to provide a vector of custom colors for the spectrogram.
+* `maximum_frequency` -- the maximum frequency to be displayed for the spectrogram
+* `dynamic_range` -- values greater than this many dB below the maximum will be displayed in the same color
+* `window_length` -- the desired length in milliseconds for the analysis window
* `output_file` -- the name of the output file
* `output_width` -- the width of the device
* `output_height` -- the height of the device
-* `output_units` -- the units in which height and width are given. Can be "px" (pixels, the default), "in" (inches), "cm" or "mm".
+* `output_units` -- the units in which height and width are given. This can be "px" (pixels, which is the default value), "in" (inches), "cm" or "mm".
-If the `output_file` argument is provided, then instead of creating plot in R it will be saved on the users disk:
+If the `output_file` argument is provided, R will save the plot in your directory instead of displaying it.
```{r}
draw_sound(file_name = "s1/s1_sounds/1_s1_ı.wav", output_file = "s1/s1_tip", title = "s1 tip")
@@ -294,7 +294,7 @@ draw_sound(file_name = "s1/s1_sounds/1_s1_ı.wav", output_file = "s1/s1_tip", ti
tree | tail -n 21 | head -n 19
```
-It is also possible to create pictures from all .wav files in a folder. For this purposes one need to specify a folder with sound files (argument `sounds_from_folder`) and folder name for pictures (argument `pic_folder_name`). The new picture folder alwayes created in the folder of the upper level, so sound and picture folders are on the same level in the folder tree structure:
+It is also possible to create visualizations of all .wav files in a folder. For this purpose you need to specify a source folder with the argument `sounds_from_folder` and a target folder for the images (`pic_folder_name`). The new image folder is automatically created in the upper level folder, so that sound and image folders are on the same level in the tree structure of your directory.
```{r}
draw_sound(sounds_from_folder = "s1/s1_sounds/",
@@ -318,7 +318,7 @@ create_viewer(audio_dir = "s1/s1_sounds/",
output_file = "stimuli_viewer")
```
-As a result in `s1` folder appeared an `stimuli_viewer.html` file.
+As a result, a `stimuli_viewer.html` was created in the `s1` folder.
```{bash, echo = FALSE}
tree | tail -n 26 | head -n 24