From ecaf98b44a469def0e22b71ac69e0a2a28d6caf2 Mon Sep 17 00:00:00 2001 From: Hadley Wickham Date: Fri, 6 Sep 2024 10:43:53 +0100 Subject: [PATCH] Update authors; add package doc (#292) --- DESCRIPTION | 4 ++-- R/R6-package.R | 6 ++++++ man/R6-package.Rd | 30 ++++++++++++++++++++++++++++++ 3 files changed, 38 insertions(+), 2 deletions(-) create mode 100644 R/R6-package.R create mode 100644 man/R6-package.Rd diff --git a/DESCRIPTION b/DESCRIPTION index 3b72907..b8e1743 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,8 +2,8 @@ Package: R6 Title: Encapsulated Classes with Reference Semantics Version: 2.5.1.9000 Authors@R: c( - person("Winston", "Chang", , "winston@stdout.org", role = c("aut", "cre")), - person("RStudio", role = c("cph", "fnd")) + person("Winston", "Chang", , "winston@posit.co", role = c("aut", "cre")), + person("Posit Software, PBC", role = c("cph", "fnd")) ) Description: Creates classes with reference semantics, similar to R's built-in reference classes. Compared to reference classes, R6 classes diff --git a/R/R6-package.R b/R/R6-package.R new file mode 100644 index 0000000..a65cf64 --- /dev/null +++ b/R/R6-package.R @@ -0,0 +1,6 @@ +#' @keywords internal +"_PACKAGE" + +## usethis namespace: start +## usethis namespace: end +NULL diff --git a/man/R6-package.Rd b/man/R6-package.Rd new file mode 100644 index 0000000..ee1c501 --- /dev/null +++ b/man/R6-package.Rd @@ -0,0 +1,30 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/R6-package.R +\docType{package} +\name{R6-package} +\alias{R6-package} +\title{R6: Encapsulated Classes with Reference Semantics} +\description{ +\if{html}{\figure{logo.png}{options: style='float: right' alt='logo' width='120'}} + +Creates classes with reference semantics, similar to R's built-in reference classes. Compared to reference classes, R6 classes are simpler and lighter-weight, and they are not built on S4 classes so they do not require the methods package. These classes allow public and private members, and they support inheritance, even when the classes are defined in different packages. +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://r6.r-lib.org} + \item \url{https://github.com/r-lib/R6/} + \item Report bugs at \url{https://github.com/r-lib/R6/issues} +} + +} +\author{ +\strong{Maintainer}: Winston Chang \email{winston@posit.co} + +Other contributors: +\itemize{ + \item Posit Software, PBC [copyright holder, funder] +} + +} +\keyword{internal}