Skip to content

Commit 53e4720

Browse files
Docs and export.
1 parent 5d52316 commit 53e4720

11 files changed

+192
-16
lines changed

DESCRIPTION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ Package: interface
22
Type: Package
33
Title: Typings and interfaces for data validation and safety in R
44
Version: 0.0.3
5+
URL: https://github.com/dereckmezquita/interface
56
Authors@R:
67
person(given = "Dereck",
78
family = "Mezquita",

NAMESPACE

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
# Generated by roxygen2: do not edit by hand
22

3+
S3method("$",enum)
34
S3method("$",interface_object)
5+
S3method("$<-",enum)
46
S3method("$<-",interface_object)
57
S3method("$<-",typed_frame)
8+
S3method("==",enum)
69
S3method("[<-",typed_frame)
10+
S3method(print,enum)
11+
S3method(print,enum_generator)
712
S3method(print,interface_object)
813
S3method(print,typed_frame)
914
S3method(print,typed_function)
1015
S3method(rbind,typed_frame)
1116
S3method(summary,typed_frame)
17+
export(enum)
1218
export(fun)
1319
export(interface)
1420
export(type.frame)

R/enum.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
#'
77
#' @param ... The possible values for the enumerated type. These should be unique character strings.
88
#' @return A function (enum generator) that creates enum objects of the defined type.
9-
#' @export
109
#'
1110
#' @examples
1211
#' # Create an enum type for colors
@@ -32,6 +31,7 @@
3231
#' try(my_shape$color$value <- "yellow") # This will raise an error
3332
#'
3433
#' @seealso \code{\link{interface}} for using enums in interfaces
34+
#' @export
3535
enum <- function(...) {
3636
values <- c(...)
3737

man/cash-.enum.Rd

Lines changed: 24 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/cash-set-.enum.Rd

Lines changed: 27 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/enum.Rd

Lines changed: 45 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/equals-.enum.Rd

Lines changed: 27 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/interface.Rd

Lines changed: 20 additions & 11 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/print.enum.Rd

Lines changed: 21 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/print.enum_generator.Rd

Lines changed: 20 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/validate_property.Rd

Lines changed: 0 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)