|
| 1 | +#' maidr: Multimodal Access and Interactive Data Representation |
| 2 | +#' |
| 3 | +#' @description |
| 4 | +#' The 'maidr' package provides accessible, interactive visualizations through |
| 5 | +#' the MAIDR (Multimodal Access and Interactive Data Representation) system. |
| 6 | +#' It converts 'ggplot2' and Base R plots into accessible HTML/SVG formats with |
| 7 | +#' keyboard navigation, screen reader support, and sonification capabilities. |
| 8 | +#' This enables users with visual impairments to independently explore and |
| 9 | +#' understand data visualizations through multiple sensory modalities. |
| 10 | +#' |
| 11 | +#' @section Main Functions: |
| 12 | +#' \itemize{ |
| 13 | +#' \item \code{\link{show}}: Display an interactive MAIDR plot in the browser or RStudio Viewer |
| 14 | +#' \item \code{\link{save_html}}: Save a plot as a standalone HTML file |
| 15 | +#' \item \code{\link{run_example}}: Run interactive example plots |
| 16 | +#' \item \code{\link{maidr_on}}: Enable automatic MAIDR interception in RMarkdown |
| 17 | +#' \item \code{\link{maidr_off}}: Disable automatic MAIDR interception |
| 18 | +#' \item \code{\link{render_maidr}}: Render MAIDR plots in Shiny applications |
| 19 | +#' \item \code{\link{maidr_output}}: Create MAIDR output container for Shiny UI |
| 20 | +#' } |
| 21 | +#' |
| 22 | +#' @section Supported Plot Types: |
| 23 | +#' The package supports a wide variety of plot types from both 'ggplot2' and |
| 24 | +#' Base R plotting systems: |
| 25 | +#' |
| 26 | +#' \strong{ggplot2 plots:} |
| 27 | +#' \itemize{ |
| 28 | +#' \item Bar charts (simple, grouped, stacked) - \code{geom_bar()}, \code{geom_col()} |
| 29 | +#' \item Histograms - \code{geom_histogram()} |
| 30 | +#' \item Scatter plots - \code{geom_point()} |
| 31 | +#' \item Line plots - \code{geom_line()} |
| 32 | +#' \item Box plots - \code{geom_boxplot()} |
| 33 | +#' \item Violin plots - \code{geom_violin()} |
| 34 | +#' \item Heat maps - \code{geom_tile()} |
| 35 | +#' \item Density/smooth curves - \code{geom_density()}, \code{geom_smooth()} |
| 36 | +#' \item Faceted plots - \code{facet_wrap()}, \code{facet_grid()} |
| 37 | +#' \item Multi-panel layouts (via 'patchwork' package) |
| 38 | +#' \item Multi-layered plot combinations |
| 39 | +#' } |
| 40 | +#' |
| 41 | +#' \strong{Base R plots:} |
| 42 | +#' \itemize{ |
| 43 | +#' \item Bar plots (simple, grouped, stacked) - \code{barplot()} |
| 44 | +#' \item Histograms - \code{hist()} |
| 45 | +#' \item Scatter and line plots - \code{plot()}, \code{points()}, \code{lines()} |
| 46 | +#' \item Box plots - \code{boxplot()} |
| 47 | +#' \item Heat maps - \code{image()}, \code{heatmap()} |
| 48 | +#' \item Multi-panel layouts - \code{par(mfrow)}, \code{par(mfcol)} |
| 49 | +#' } |
| 50 | +#' |
| 51 | +#' @section Accessibility Features: |
| 52 | +#' \itemize{ |
| 53 | +#' \item \strong{Keyboard Navigation}: Use arrow keys to explore data points |
| 54 | +#' \item \strong{Screen Reader Support}: ARIA labels and live regions for announcements |
| 55 | +#' \item \strong{Sonification}: Audio representation of data patterns |
| 56 | +#' \item \strong{Text Summaries}: Automatic statistical descriptions |
| 57 | +#' \item \strong{Grid Navigation}: Efficient exploration of scatter plots |
| 58 | +#' } |
| 59 | +#' |
| 60 | +#' @section Integration: |
| 61 | +#' The package integrates seamlessly with: |
| 62 | +#' \itemize{ |
| 63 | +#' \item \strong{RStudio}: Direct display in the Viewer pane |
| 64 | +#' \item \strong{RMarkdown/Quarto}: Automatic rendering with \code{maidr_on()} |
| 65 | +#' \item \strong{Shiny}: Interactive plots in Shiny apps via \code{render_maidr()} |
| 66 | +#' \item \strong{Standalone HTML}: Export plots for sharing with \code{save_html()} |
| 67 | +#' } |
| 68 | +#' |
| 69 | +#' @section Getting Started: |
| 70 | +#' To create your first accessible plot: |
| 71 | +#' \preformatted{ |
| 72 | +#' library(maidr) |
| 73 | +#' library(ggplot2) |
| 74 | +#' |
| 75 | +#' # Create a ggplot2 plot |
| 76 | +#' p <- ggplot(mtcars, aes(x = factor(cyl), y = mpg)) + |
| 77 | +#' geom_boxplot() |
| 78 | +#' |
| 79 | +#' # Display as interactive MAIDR plot |
| 80 | +#' show(p) |
| 81 | +#' |
| 82 | +#' # Or save to HTML file |
| 83 | +#' save_html(p, file = "my_plot.html") |
| 84 | +#' } |
| 85 | +#' |
| 86 | +#' For Base R plots: |
| 87 | +#' \preformatted{ |
| 88 | +#' library(maidr) |
| 89 | +#' |
| 90 | +#' # Create a Base R plot |
| 91 | +#' barplot(table(mtcars$cyl)) |
| 92 | +#' |
| 93 | +#' # Display as interactive MAIDR plot |
| 94 | +#' show() |
| 95 | +#' } |
| 96 | +#' |
| 97 | +#' @section Learn More: |
| 98 | +#' \itemize{ |
| 99 | +#' \item Package website: \url{https://r.maidr.ai/} |
| 100 | +#' \item MAIDR project: \url{https://maidr.ai/} |
| 101 | +#' \item GitHub repository: \url{https://github.com/xability/r-maidr} |
| 102 | +#' \item Get started: \code{vignette("getting-started", package = "maidr")} |
| 103 | +#' \item Shiny integration: \code{vignette("shiny-integration", package = "maidr")} |
| 104 | +#' } |
| 105 | +#' |
| 106 | +#' @keywords internal |
| 107 | +"_PACKAGE" |
| 108 | + |
| 109 | +## usethis namespace: start |
| 110 | +## usethis namespace: end |
| 111 | +NULL |
0 commit comments