diff --git a/DESCRIPTION b/DESCRIPTION index d009d4a..a447571 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: talkr Type: Package Title: Plotting Conversation Data -Version: 0.1.2 +Version: 0.1.3 Authors@R: c( person("Mark", "Dingemanse", email = "mark.dingemanse@ru.nl", role = c("aut", "cre")), person("Barbara", "Vreede", email = "b.vreede@gmail.com", role = "aut"), @@ -10,7 +10,11 @@ Authors@R: c( person("Andreas", "Liesenfeld", email = "andreas.liesenfeld@ru.nl", role = "ctb"), person("Netherlands eScience Center", role = c("cph", "fnd")) ) -Description: Functions to plot elements of conversations. +Description: Visualisation, analysis and quality control of conversational data. + Rapid and visual insights into the nature, timing and quality of + time-aligned annotations in conversational corpora. + For more details, see + Dingemanse et al., (2022) . License: Apache License (>= 2) Encoding: UTF-8 LazyData: true diff --git a/R/geom_token.R b/R/geom_token.R index 28e82e5..3c349aa 100644 --- a/R/geom_token.R +++ b/R/geom_token.R @@ -7,6 +7,8 @@ #' @param data A tokenized data frame (see `tokenize()`). #' @inheritParams ggplot2::layer #' @inheritParams ggplot2::geom_point +#' +#' @return A ggplot2 layer corresponding to a token #' @export geom_token <- function(data, mapping = NULL, stat = "identity", position = "identity", diff --git a/R/geom_turn.R b/R/geom_turn.R index 9334fc7..890a9e1 100644 --- a/R/geom_turn.R +++ b/R/geom_turn.R @@ -6,6 +6,8 @@ #' @inheritParams ggplot2::layer #' @inheritParams ggplot2::geom_rect #' @param height The height of the turn-taking rectangles +#' +#' @return A ggplot2 layer corresponding to a turn-taking rectangle #' @export geom_turn <- function(mapping = NULL, data = NULL, stat = "identity", position = "identity", diff --git a/R/report.R b/R/report.R index b889547..ec85409 100644 --- a/R/report.R +++ b/R/report.R @@ -11,6 +11,7 @@ #' #' @param data talkr dataset #' +#' @return No return, just prints a summary to the console #' @export report_stats <- function(data) { summary <- report(data) diff --git a/R/theme_turnPlot.R b/R/theme_turnPlot.R index a225168..e4117f3 100644 --- a/R/theme_turnPlot.R +++ b/R/theme_turnPlot.R @@ -1,12 +1,13 @@ -#' theme for the turn plot +#' T heme for the turn plot #' #' @param base_size int #' @param base_family chr #' @param ticks bool #' #' @importFrom ggplot2 %+replace% +#' +#' @return ggplot2 custom theme for turn plots #' @export -#' theme_turnPlot <- function(base_size = 11, base_family = "serif", ticks = TRUE) { ggthemes::theme_tufte( base_size = base_size, diff --git a/man/geom_token.Rd b/man/geom_token.Rd index dccb59e..d90a7b8 100644 --- a/man/geom_token.Rd +++ b/man/geom_token.Rd @@ -91,6 +91,9 @@ 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. \code{\link[ggplot2:borders]{borders()}}.} } +\value{ +A ggplot2 layer corresponding to a token +} \description{ From a separate data frame containing tokenized data, plot individual tokens at their estimated time. Data must be provided separately, and should diff --git a/man/geom_turn.Rd b/man/geom_turn.Rd index 363a971..5d3c339 100644 --- a/man/geom_turn.Rd +++ b/man/geom_turn.Rd @@ -106,6 +106,9 @@ 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. \code{\link[ggplot2:borders]{borders()}}.} } +\value{ +A ggplot2 layer corresponding to a turn-taking rectangle +} \description{ Show turn-taking in visualized conversations } diff --git a/man/report_stats.Rd b/man/report_stats.Rd index d084b95..05176cd 100644 --- a/man/report_stats.Rd +++ b/man/report_stats.Rd @@ -9,6 +9,9 @@ report_stats(data) \arguments{ \item{data}{talkr dataset} } +\value{ +No return, just prints a summary to the console +} \description{ Basic conversation statistics are reported to the console: - Corpus-level statistics, reporting on the dataset as a whole; diff --git a/man/theme_turnPlot.Rd b/man/theme_turnPlot.Rd index dfef4e0..db36b45 100644 --- a/man/theme_turnPlot.Rd +++ b/man/theme_turnPlot.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/theme_turnPlot.R \name{theme_turnPlot} \alias{theme_turnPlot} -\title{theme for the turn plot} +\title{T heme for the turn plot} \usage{ theme_turnPlot(base_size = 11, base_family = "serif", ticks = TRUE) } @@ -13,6 +13,9 @@ theme_turnPlot(base_size = 11, base_family = "serif", ticks = TRUE) \item{ticks}{bool} } +\value{ +ggplot2 custom theme for turn plots +} \description{ -theme for the turn plot +T heme for the turn plot }