From 7561645620116b4c4d476dd7acbfee5218dfd690 Mon Sep 17 00:00:00 2001 From: aravindhebbali Date: Mon, 5 Aug 2024 20:28:01 +0530 Subject: [PATCH] docs: closes #40 --- DESCRIPTION | 2 +- R/xplorerr.R | 4 +++- man/xplorerr.Rd | 15 +++++++++++++++ 3 files changed, 19 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 5da8f35..ca52871 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -41,6 +41,6 @@ BugReports: https://github.com/rsquaredacademy/xplorerr/issues License: MIT + file LICENSE Encoding: UTF-8 LazyData: true -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.2 LinkingTo: Rcpp diff --git a/R/xplorerr.R b/R/xplorerr.R index e7a25e7..3c90536 100644 --- a/R/xplorerr.R +++ b/R/xplorerr.R @@ -6,10 +6,12 @@ #' \href{https://github.com/rsquaredacademy/xplorerr}{GitHub} #' #' @docType package +#' @keywords internal #' @importFrom Rcpp sourceCpp #' @useDynLib xplorerr #' @name xplorerr -NULL +#' @aliases xplorerr-package +"_PACKAGE" ## quiets concerns of R CMD check re: the .'s that appear in pipelines if(getRversion() >= "2.15.1") utils::globalVariables(c(".", diff --git a/man/xplorerr.Rd b/man/xplorerr.Rd index 3c38b8d..3b940ea 100644 --- a/man/xplorerr.Rd +++ b/man/xplorerr.Rd @@ -3,6 +3,7 @@ \docType{package} \name{xplorerr} \alias{xplorerr} +\alias{xplorerr-package} \title{\code{xplorerr} package} \description{ R Shiny app for interactive statistical analysis @@ -11,3 +12,17 @@ R Shiny app for interactive statistical analysis See the README on \href{https://github.com/rsquaredacademy/xplorerr}{GitHub} } +\seealso{ +Useful links: +\itemize{ + \item \url{https://github.com/rsquaredacademy/xplorerr} + \item \url{https://xplorerr.rsquaredacademy.com/} + \item Report bugs at \url{https://github.com/rsquaredacademy/xplorerr/issues} +} + +} +\author{ +\strong{Maintainer}: Aravind Hebbali \email{hebbali.aravind@gmail.com} (\href{https://orcid.org/0000-0001-9220-9669}{ORCID}) + +} +\keyword{internal}