diff --git a/news/index.html b/news/index.html index 1b7fca2..9090819 100644 --- a/news/index.html +++ b/news/index.html @@ -33,7 +33,9 @@

Changelog

dotty 0.2.0 (UNRELEASED)

-
+

dotty 0.1.0

CRAN release: 2024-08-30

+
+

Arguments

+ + +
object
+

An R object.

+ +

Details

Packages which would like to define special destructring diff --git a/reference/dotify.html b/reference/dotify.html new file mode 100644 index 0000000..8293117 --- /dev/null +++ b/reference/dotify.html @@ -0,0 +1,83 @@ + +Dotify an R Package — dotify • dotty + Skip to contents + + +

+
+
+ +

Dotify an R Package

+ +
dotify.Rd
+
+ +
+

When using `dotty` within an R package, you might see **NOTE**s during +`R CMD check` of the form:

+
+ +
+

Usage

+ 
dotify()
+
+ +
+

Details

+

“` +N checking R code for possible problems (1.8s) + <package>: no visible binding for global variable <variable> + Undefined global functions or variables: + <variable> +“`

+

This occurs because the [codetools] package, which is used for static +analysis of R code during `R CMD check`, does not recognize that e.g. +`.[apple] <- 42` would create a variable called `apple` in the current +scope. Calling `dotty::dotify()` in your package's `.onLoad()` will +allow `dotty` to patch `codetools` in a way that will allow it to +understand `dotty` usages, and so prevent these `R CMD check` notes +from being emitted.

+
+ +
+ + +
+

Developed by Kevin Ushey.

+
+ +
+

Site built with pkgdown 2.1.0.

+
+ +
+ + + + + + + diff --git a/reference/index.html b/reference/index.html index 899bf0e..bf75d43 100644 --- a/reference/index.html +++ b/reference/index.html @@ -49,6 +49,12 @@

All functionsdotify() + + +
Dotify an R Package
+
+ .
diff --git a/search.json b/search.json index 8547239..0f0b0d2 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":"https://kevinushey.github.io/dotty/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Kevin Ushey. Author, maintainer.","code":""},{"path":"https://kevinushey.github.io/dotty/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Ushey K (2024). dotty: Unpacking Dot Operator. R package version 0.1.0.9000, https://kevinushey.github.io/dotty/.","code":"@Manual{, title = {dotty: The Unpacking Dot Operator}, author = {Kevin Ushey}, year = {2024}, note = {R package version 0.1.0.9000}, url = {https://kevinushey.github.io/dotty/}, }"},{"path":"https://kevinushey.github.io/dotty/index.html","id":"dotty","dir":"","previous_headings":"","what":"The Unpacking Dot Operator","title":"The Unpacking Dot Operator","text":"Destructuring assignments R . object.","code":""},{"path":"https://kevinushey.github.io/dotty/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"The Unpacking Dot Operator","text":"","code":"library(dotty) # extract number of rows, number of columns from mtcars .[nr, nc] <- dim(mtcars) c(nr, nc) ## [1] 32 11 # extract first, last element of vector .[first, .., last] <- c(1, 2, 3, 4, 5) c(first, last) ## [1] 1 5 # extract a value by name .[beta = beta] <- list(alpha = 1, beta = 2, gamma = 3) beta ## [1] 2 # unpack nested values .[x, .[y, .[z]]] <- list(1, list(2, list(3))) c(x, y, z) ## [1] 1 2 3 # split version components .[major, minor, patch] <- getRversion() c(major, minor, patch) ## [1] 4 4 1"},{"path":"https://kevinushey.github.io/dotty/index.html","id":"r-cmd-check","dir":"","previous_headings":"","what":"R CMD check","title":"The Unpacking Dot Operator","text":"’d like use dotty CRAN package, can avoid R CMD check warnings including file called R/zzz.R contents: function patches codetools variables usages . expressions can linted though regular bindings / assignments.","code":".onLoad <- function(libname, pkgname) { dotty::dotify() }"},{"path":"https://kevinushey.github.io/dotty/reference/destructure.html","id":null,"dir":"Reference","previous_headings":"","what":"Destructure an Object — destructure","title":"Destructure an Object — destructure","text":"`destructure` primarily used help define object prepared, transformed, prior destructuring assignment. can relevant objects unique subsetting semantics – example, [numeric_version] objects.","code":""},{"path":"https://kevinushey.github.io/dotty/reference/destructure.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Destructure an Object — destructure","text":"","code":"destructure(object)"},{"path":"https://kevinushey.github.io/dotty/reference/destructure.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Destructure an Object — destructure","text":"Packages like define special destructring semantics certain object classes can implement methods class.","code":""},{"path":"https://kevinushey.github.io/dotty/reference/dotty.html","id":null,"dir":"Reference","previous_headings":"","what":"The Destructuring Dot Operator — .","title":"The Destructuring Dot Operator — .","text":"Use `dotty` perform destructuring assignments. Please see examples usages.","code":""},{"path":"https://kevinushey.github.io/dotty/reference/dotty.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The Destructuring Dot Operator — .","text":"","code":"."},{"path":"https://kevinushey.github.io/dotty/reference/dotty.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"The Destructuring Dot Operator — .","text":"object class dotty length 0.","code":""},{"path":"https://kevinushey.github.io/dotty/reference/dotty.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"The Destructuring Dot Operator — .","text":"","code":"# extract number of rows, number of columns from mtcars .[nr, nc] <- dim(mtcars) c(nr, nc) #> [1] 32 11 # extract first, last element of vector .[first, .., last] <- c(1, 2, 3, 4, 5) c(first, last) #> [1] 1 5 # extract a value by name .[beta = beta] <- list(alpha = 1, beta = 2, gamma = 3) beta #> [1] 2 # unpack nested values .[x, .[y, .[z]]] <- list(1, list(2, list(3))) c(x, y, z) #> [1] 1 2 3 # split version components .[major, minor, patch] <- getRversion() c(major, minor, patch) #> [1] 4 4 1"},{"path":[]},{"path":"https://kevinushey.github.io/dotty/news/index.html","id":"dotty-010","dir":"Changelog","previous_headings":"","what":"dotty 0.1.0","title":"dotty 0.1.0","text":"CRAN release: 2024-08-30 Initial CRAN release.","code":""}] +[{"path":"https://kevinushey.github.io/dotty/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Kevin Ushey. Author, maintainer.","code":""},{"path":"https://kevinushey.github.io/dotty/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Ushey K (2024). dotty: Unpacking Dot Operator. R package version 0.1.0.9000, https://kevinushey.github.io/dotty/.","code":"@Manual{, title = {dotty: The Unpacking Dot Operator}, author = {Kevin Ushey}, year = {2024}, note = {R package version 0.1.0.9000}, url = {https://kevinushey.github.io/dotty/}, }"},{"path":"https://kevinushey.github.io/dotty/index.html","id":"dotty","dir":"","previous_headings":"","what":"The Unpacking Dot Operator","title":"The Unpacking Dot Operator","text":"Destructuring assignments R . object.","code":""},{"path":"https://kevinushey.github.io/dotty/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"The Unpacking Dot Operator","text":"","code":"library(dotty) # extract number of rows, number of columns from mtcars .[nr, nc] <- dim(mtcars) c(nr, nc) ## [1] 32 11 # extract first, last element of vector .[first, .., last] <- c(1, 2, 3, 4, 5) c(first, last) ## [1] 1 5 # extract a value by name .[beta = beta] <- list(alpha = 1, beta = 2, gamma = 3) beta ## [1] 2 # unpack nested values .[x, .[y, .[z]]] <- list(1, list(2, list(3))) c(x, y, z) ## [1] 1 2 3 # split version components .[major, minor, patch] <- getRversion() c(major, minor, patch) ## [1] 4 4 1"},{"path":"https://kevinushey.github.io/dotty/index.html","id":"r-cmd-check","dir":"","previous_headings":"","what":"R CMD check","title":"The Unpacking Dot Operator","text":"’d like use dotty CRAN package, can avoid R CMD check warnings including file called R/zzz.R contents: function patches codetools variables usages . expressions can linted though regular bindings / assignments.","code":".onLoad <- function(libname, pkgname) { dotty::dotify() }"},{"path":"https://kevinushey.github.io/dotty/reference/destructure.html","id":null,"dir":"Reference","previous_headings":"","what":"Destructure an Object — destructure","title":"Destructure an Object — destructure","text":"`destructure` primarily used help define object prepared, transformed, prior destructuring assignment. can relevant objects unique subsetting semantics – example, [numeric_version] objects.","code":""},{"path":"https://kevinushey.github.io/dotty/reference/destructure.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Destructure an Object — destructure","text":"","code":"destructure(object)"},{"path":"https://kevinushey.github.io/dotty/reference/destructure.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Destructure an Object — destructure","text":"object R object.","code":""},{"path":"https://kevinushey.github.io/dotty/reference/destructure.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Destructure an Object — destructure","text":"Packages like define special destructring semantics certain object classes can implement methods class.","code":""},{"path":"https://kevinushey.github.io/dotty/reference/dotify.html","id":null,"dir":"Reference","previous_headings":"","what":"Dotify an R Package — dotify","title":"Dotify an R Package — dotify","text":"using `dotty` within R package, might see **NOTE**s `R CMD check` form:","code":""},{"path":"https://kevinushey.github.io/dotty/reference/dotify.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Dotify an R Package — dotify","text":"","code":"dotify()"},{"path":"https://kevinushey.github.io/dotty/reference/dotify.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Dotify an R Package — dotify","text":"“` N checking R code possible problems (1.8s) : visible binding global variable Undefined global functions variables: “` occurs [codetools] package, used static analysis R code `R CMD check`, recognize e.g. `.[apple] <- 42` create variable called `apple` current scope. Calling `dotty::dotify()` package's `.onLoad()` allow `dotty` patch `codetools` way allow understand `dotty` usages, prevent `R CMD check` notes emitted.","code":""},{"path":"https://kevinushey.github.io/dotty/reference/dotty.html","id":null,"dir":"Reference","previous_headings":"","what":"The Destructuring Dot Operator — .","title":"The Destructuring Dot Operator — .","text":"Use `dotty` perform destructuring assignments. Please see examples usages.","code":""},{"path":"https://kevinushey.github.io/dotty/reference/dotty.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"The Destructuring Dot Operator — .","text":"","code":"."},{"path":"https://kevinushey.github.io/dotty/reference/dotty.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"The Destructuring Dot Operator — .","text":"object class dotty length 0.","code":""},{"path":"https://kevinushey.github.io/dotty/reference/dotty.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"The Destructuring Dot Operator — .","text":"","code":"# extract number of rows, number of columns from mtcars .[nr, nc] <- dim(mtcars) c(nr, nc) #> [1] 32 11 # extract first, last element of vector .[first, .., last] <- c(1, 2, 3, 4, 5) c(first, last) #> [1] 1 5 # extract a value by name .[beta = beta] <- list(alpha = 1, beta = 2, gamma = 3) beta #> [1] 2 # unpack nested values .[x, .[y, .[z]]] <- list(1, list(2, list(3))) c(x, y, z) #> [1] 1 2 3 # split version components .[major, minor, patch] <- getRversion() c(major, minor, patch) #> [1] 4 4 1"},{"path":"https://kevinushey.github.io/dotty/news/index.html","id":"dotty-020-unreleased","dir":"Changelog","previous_headings":"","what":"dotty 0.2.0 (UNRELEASED)","title":"dotty 0.2.0 (UNRELEASED)","text":"dotty::dotify() now exported use R packages like use dotty internally. (#1)","code":""},{"path":"https://kevinushey.github.io/dotty/news/index.html","id":"dotty-010","dir":"Changelog","previous_headings":"","what":"dotty 0.1.0","title":"dotty 0.1.0","text":"CRAN release: 2024-08-30 Initial CRAN release.","code":""}] diff --git a/sitemap.xml b/sitemap.xml index a7420c2..b1955e3 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -5,6 +5,7 @@ https://kevinushey.github.io/dotty/index.html https://kevinushey.github.io/dotty/news/index.html https://kevinushey.github.io/dotty/reference/destructure.html +https://kevinushey.github.io/dotty/reference/dotify.html https://kevinushey.github.io/dotty/reference/dotty.html https://kevinushey.github.io/dotty/reference/index.html