From d9dd432e655f5e8f5e4884c9bf31102323ab4d71 Mon Sep 17 00:00:00 2001 From: Dean Attali Date: Sat, 19 Aug 2023 19:45:42 -0400 Subject: [PATCH] add correct package file docs (see r-lib/roxygen2#1491) --- R/colourpicker-package.R | 13 ++----------- man/colourpicker-package.Rd | 26 ++++++++++++++++++++------ 2 files changed, 22 insertions(+), 17 deletions(-) diff --git a/R/colourpicker-package.R b/R/colourpicker-package.R index 471aea5..0cc9deb 100644 --- a/R/colourpicker-package.R +++ b/R/colourpicker-package.R @@ -1,11 +1,2 @@ -#' colourpicker -#' -#' A colour picker tool for Shiny and for selecting colours in plots -#' -#' A colour picker that can be used as an input in Shiny apps or Rmarkdown documents. The colour picker supports alpha opacity, custom colour palettes, and many more options. A Plot Colour Helper tool is available as an RStudio Addin, which helps you pick colours to use in your plots. A more generic Colour Picker RStudio Addin is also provided to let you select colours to use in your R code. -#' -#' View the \href{https://github.com/daattali/colourpicker}{full README} for more details -#' and to see demos. -#' @docType package -#' @name colourpicker-package -NULL +#' @keywords internal +"_PACKAGE" diff --git a/man/colourpicker-package.Rd b/man/colourpicker-package.Rd index 580c83b..33f0a7b 100644 --- a/man/colourpicker-package.Rd +++ b/man/colourpicker-package.Rd @@ -2,14 +2,28 @@ % Please edit documentation in R/colourpicker-package.R \docType{package} \name{colourpicker-package} +\alias{colourpicker} \alias{colourpicker-package} -\title{colourpicker} +\title{colourpicker: A Colour Picker Tool for Shiny and for Selecting Colours in Plots} \description{ -A colour picker tool for Shiny and for selecting colours in plots +A colour picker that can be used as an input in 'Shiny' apps or Rmarkdown documents. The colour picker supports alpha opacity, custom colour palettes, and many more options. A Plot Colour Helper tool is available as an 'RStudio' Addin, which helps you pick colours to use in your plots. A more generic Colour Picker 'RStudio' Addin is also provided to let you select colours to use in your R code. +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://github.com/daattali/colourpicker} + \item \url{https://daattali.com/shiny/colourInput/} + \item Report bugs at \url{https://github.com/daattali/colourpicker/issues} +} + +} +\author{ +\strong{Maintainer}: Dean Attali \email{daattali@gmail.com} (\href{https://orcid.org/0000-0002-5645-3493}{ORCID}) + +Other contributors: +\itemize{ + \item David Griswold \email{novachild@gmail.com} [contributor] } -\details{ -A colour picker that can be used as an input in Shiny apps or Rmarkdown documents. The colour picker supports alpha opacity, custom colour palettes, and many more options. A Plot Colour Helper tool is available as an RStudio Addin, which helps you pick colours to use in your plots. A more generic Colour Picker RStudio Addin is also provided to let you select colours to use in your R code. -View the \href{https://github.com/daattali/colourpicker}{full README} for more details -and to see demos. } +\keyword{internal}