Merge branch 'main' into explore_geom

.Rbuildignore

@@ -1,4 +1,6 @@
 ^.*\.Rproj$
 ^\.Rproj\.user$
 ^LICENSE\.md$
+^\.github$
+sonar.project.properties
 ^working_example.R

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.github/workflows/R-CMD-check.yaml

@@ -0,0 +1,51 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+name: R-CMD-check
+
+jobs:
+  R-CMD-check:
+    runs-on: ${{ matrix.config.os }}
+
+    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          # - {os: macos-latest,   r: 'release'}
+          # - {os: windows-latest, r: 'release'}
+          # - {os: ubuntu-latest,   r: 'devel', http-user-agent: 'release'}
+          - {os: ubuntu-latest,   r: 'release'}
+          # - {os: ubuntu-latest,   r: 'oldrel-1'}
+
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      R_KEEP_PKG_SOURCE: yes
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          r-version: ${{ matrix.config.r }}
+          http-user-agent: ${{ matrix.config.http-user-agent }}
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::rcmdcheck
+          needs: check
+
+      - uses: r-lib/actions/check-r-package@v2
+        with:
+          upload-snapshots: true

.github/workflows/test-coverage.yaml

@@ -0,0 +1,42 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+name: test-coverage
+
+jobs:
+  test-coverage:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::covr
+          needs: coverage
+
+      - name: Generate coverage report
+        run: |
+          covr::codecov(
+            quiet = FALSE,
+            clean = FALSE,
+            install_path = file.path(Sys.getenv("RUNNER_TEMP"), "package")
+          )
+        shell: Rscript {0}
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -5,3 +5,4 @@
 inst/doc
 *.rda
 *.wav
+.DS_Store

DESCRIPTION

@@ -14,6 +14,7 @@ License: Apache License (>= 2)
 Encoding: UTF-8
 LazyData: true
 Suggests: 
+    devtools,
     rmarkdown,
     testthat (>= 3.0.0)
 VignetteBuilder: knitr
@@ -25,7 +26,6 @@ Imports:
     ggrepel,
     ggthemes,
     knitr,
-    magrittr,
     stats,
     stringx,
     tidyr,

NAMESPACE

@@ -1,19 +1,13 @@
 # Generated by roxygen2: do not edit by hand
 
 export(add_lines)
+export(check_quality)
 export(convplot)
 export(geom_turn)
 export(GeomTurn)
-export(inspect_corpus)
+export(init)
 export(inspect_language)
 export(report_summaries)
 export(theme_turnPlot)
-import(cowplot)
-import(dplyr)
 import(ggplot2)
-import(ggrepel)
-import(ggthemes)
-import(knitr)
-import(magrittr)
-import(tidyr)
 import(viridis)

R/geom_turn.R

@@ -9,6 +9,7 @@
 #' @param inherit.aes If FALSE, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. borders().
 #' @param ... Other arguments passed on to layer(). These are often aesthetics, used to set an aesthetic to a fixed value, like colour = "red" or size = 3. They may also be parameters to the paired geom/stat.
 #' @export
+#' @rdname geom_turn
 geom_turn <- function(mapping = NULL, data = NULL,
                       stat = "identity", position = "identity",
                       ..., na.rm = FALSE, show.legend = NA, inherit.aes = TRUE) {
@@ -25,6 +26,8 @@ geom_turn <- function(mapping = NULL, data = NULL,
   )
 }
 
+#' GeomTurn
+#'
 #' @rdname ggplot2-ggproto
 #' @format NULL
 #' @usage NULL

R/init.R

@@ -0,0 +1,33 @@
+#' Initialize a `talkr` dataset
+#'
+#' From a dataframe object, generate a talkr dataset.
+#' This dataset contains columns that are used throughout the talkr
+#' infrastructure to visualize conversations and language corpora.
+#' Initializing a talkr dataset is the first step in the talkr workflow.
+#'
+#' @param data A dataframe object
+#' @param begin The column name with the begin time of the utterance (in milliseconds)
+#' @param end The column name with the end time of the utterance (in milliseconds)
+#' @param participant The column name with the participant who produced the utterance
+#' @param utterance The column name with the utterance itself
+#'
+#' @return A dataframe object with columns needed for the talkr workflow
+#' @export
+init <- function(data,
+                 begin = "begin",
+                 end = "end",
+                 participant = "participant",
+                 utterance = "utterance"){
+
+  # verify that column names declared actually exist in the dataset
+  names_required <- c(begin, end, participant, utterance)
+  check_columns(data, names_required)
+
+  data <- data |>
+    dplyr::rename(begin = begin,
+                  end = end,
+                  participant = participant,
+                  utterance = utterance)
+
+  return(data)
+}