Skip to content

Commit

Permalink
update for CRAN
Browse files Browse the repository at this point in the history
  • Loading branch information
agricolamz committed Apr 15, 2024
1 parent aedd966 commit d45b84e
Show file tree
Hide file tree
Showing 12 changed files with 35 additions and 4 deletions.
4 changes: 4 additions & 0 deletions R/df_to_eaf.R
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@
#' output_file = 'test.eaf',
#' ref_file = 'test.wav')
#'
#' # Remove file in order to pass checks
#'
#' file.remove("test.eaf")
#'
#' @importFrom mime guess_type
#' @importFrom stats na.omit
#' @export
Expand Down
4 changes: 4 additions & 0 deletions R/df_to_exb.r
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@
#' ud_meta = meta,
#' speaker_table = speaker_data)
#'
#' # Remove file in order to pass checks
#'
#' file.remove("beck.xml")
#'
#' @export

df_to_exb <- function(df,
Expand Down
2 changes: 1 addition & 1 deletion R/draw_sound.R
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
#' @return Oscilogram and spectrogram plot (and possibly TextGrid annotation).
#'
#' @examples
#' \dontrun{
#' \donttest{
#' draw_sound(system.file("extdata", "test.wav", package = "phonfieldwork"))
#'
#' draw_sound(
Expand Down
4 changes: 3 additions & 1 deletion R/draw_spectrogram.R
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,10 @@
#' columns. Optional columns are \code{colors} and \code{content}.
#' @param formant_df dataframe with formants from \code{formant_to_df()} function
#'
#' @return Plot the comptued spectrogram
#'
#' @examples
#' \dontrun{
#' \donttest{
#' draw_spectrogram(system.file("extdata", "test.wav",
#' package = "phonfieldwork"
#' ))
Expand Down
2 changes: 2 additions & 0 deletions R/get_sound_duration.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
#'
#' @param file_name a sound file
#'
#' @return Dataframe with two columns: file name and duration
#'
#' @examples
#' get_sound_duration(
#' system.file("extdata", "test.wav", package = "phonfieldwork")
Expand Down
2 changes: 2 additions & 0 deletions R/read_from_folder.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
#' @param path to a folder with multiple sound files.
#' @param type should be one of the following: "duration", "audacity", "eaf", "exb", "flextext", "formant", "intensity", "picth", "srt", "textgrid"
#'
#' @return dataframe with contents of all files of a selected type
#'
#' @examples
#'
#' read_from_folder(system.file("extdata", package = "phonfieldwork"), "eaf")
Expand Down
4 changes: 4 additions & 0 deletions man/df_to_eaf.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions man/df_to_exb.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/draw_sound.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion man/draw_spectrogram.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions man/get_sound_duration.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions man/read_from_folder.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d45b84e

Please sign in to comment.