From 48bda48f2df22b462655589c293aaa9d8fa30d57 Mon Sep 17 00:00:00 2001 From: jrwishart Date: Thu, 15 May 2025 09:26:04 +1000 Subject: [PATCH] Untracked: Fix documentation warning --- DESCRIPTION | 2 +- R/rhtmlPictographs.R | 4 ++-- man/graphic.Rd | 3 +++ theSrc/R/htmlwidget.R | 4 ++-- 4 files changed, 8 insertions(+), 5 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index b022d575..44006cf5 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -10,4 +10,4 @@ Imports: htmlwidgets License: GPL-3 LazyData: TRUE -RoxygenNote: 7.1.1 +RoxygenNote: 7.3.2 diff --git a/R/rhtmlPictographs.R b/R/rhtmlPictographs.R index d89f42f9..ba535017 100644 --- a/R/rhtmlPictographs.R +++ b/R/rhtmlPictographs.R @@ -4,6 +4,8 @@ #' #' The usage documentation is maintained as a self hosted tutorial. For instructions on how to run and view this tutorial see the project readme : https://github.com/Displayr/rhtmlPictographs #' +#' @param settingsJsonString A JSON that contains the settings +#' #' @examples #' #' red circle @@ -21,8 +23,6 @@ #' @import htmlwidgets #' #' @export -#' - graphic <- function(settingsJsonString = '{}') { g <- htmlwidgets::createWidget( name = 'rhtmlPictographs', diff --git a/man/graphic.Rd b/man/graphic.Rd index c9ce7ba4..a8b37e98 100644 --- a/man/graphic.Rd +++ b/man/graphic.Rd @@ -9,6 +9,9 @@ https://github.com/Displayr/rhtmlPictographs \usage{ graphic(settingsJsonString = "{}") } +\arguments{ +\item{settingsJsonString}{A JSON that contains the settings} +} \description{ A HTMLWidget that can generate single image graphics, mutli image graphics, or a table of single/multi image graphics. See scenarios and examples below for different use cases. diff --git a/theSrc/R/htmlwidget.R b/theSrc/R/htmlwidget.R index d89f42f9..ba535017 100644 --- a/theSrc/R/htmlwidget.R +++ b/theSrc/R/htmlwidget.R @@ -4,6 +4,8 @@ #' #' The usage documentation is maintained as a self hosted tutorial. For instructions on how to run and view this tutorial see the project readme : https://github.com/Displayr/rhtmlPictographs #' +#' @param settingsJsonString A JSON that contains the settings +#' #' @examples #' #' red circle @@ -21,8 +23,6 @@ #' @import htmlwidgets #' #' @export -#' - graphic <- function(settingsJsonString = '{}') { g <- htmlwidgets::createWidget( name = 'rhtmlPictographs',