Merge pull request #243 from r-lib/rc-0.1.0

Rc 0.1.0

.Rbuildignore

@@ -6,3 +6,5 @@
 ^LICENSE\.md$
 ^rray\.Rproj$
 ^\.Rproj\.user$
+^cran-comments\.md$
+^CRAN-RELEASE$

CRAN-RELEASE

@@ -0,0 +1,2 @@
+This package was submitted to CRAN on 2019-07-19.
+Once it is accepted, delete this file and tag the release (commit cdf05338c3).

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: rray
 Title: Simple Arrays
-Version: 0.0.0.9000
+Version: 0.1.0
 Authors@R: 
     c(person(given = "Davis",
              family = "Vaughan",
@@ -21,7 +21,7 @@ Imports:
     Rcpp (>= 1.0.1),
     rlang (>= 0.4.0),
     utils,
-    vctrs
+    vctrs (>= 0.2.0)
 Suggests: 
     covr,
     knitr,
@@ -31,8 +31,6 @@ Suggests:
 LinkingTo: 
     Rcpp,
     xtensor (>= 0.11.1-0)
-Remotes:
-    r-lib/vctrs
 VignetteBuilder: 
     knitr
 Encoding: UTF-8

NEWS.md

@@ -0,0 +1,3 @@
+# rray 0.1.0
+
+* Added a `NEWS.md` file to track changes to the package.

R/arith.R

@@ -11,6 +11,11 @@
 #' been exported, such as `%b+%`, which will perform addition with
 #' broadcasting no matter what type the input is.
 #'
+#' @return
+#'
+#' The value of the arithmetic operation, with dimensions identical to the
+#' common dimensions of the input.
+#'
 #' @param x,y A pair of vectors.
 #'
 #' @examples

R/broadcast.R

@@ -32,7 +32,7 @@
 #' ```
 #'
 #' You can broadcast to higher dimensions too. If you go from a 5x2 to a
-#' 5x2x3 array, then the 5x2 matrix implicitely gets a 1 appended as another
+#' 5x2x3 array, then the 5x2 matrix implicitly gets a 1 appended as another
 #' dimension (i.e. 5x2x1)
 #'
 #'
@@ -49,6 +49,10 @@
 #' @param x The object to broadcast.
 #' @param dim An integer vector. The dimension to broadcast to.
 #'
+#' @return
+#'
+#' `x` broadcast to the new dimensions.
+#'
 #' @examples
 #'
 #' # From 5x1 ...
@@ -66,8 +70,7 @@
 #' rray_broadcast(x, c(5, 2, 3))
 #'
 #' # You cannot broadcast down in dimensions
-#' # rray_broadcast(x, 5)
-#' # > Error: Cannot decrease dimensions of `x`
+#' try(rray_broadcast(x, 5))
 #'
 #' @export
 rray_broadcast <- function(x, dim) {

R/clip.R

@@ -10,6 +10,10 @@
 #' @param high A single value. The upper bound. `high` is cast to the
 #' inner type of `x`.
 #'
+#' @return
+#'
+#' `x` bounded by `low` and `high`.
+#'
 #' @examples
 #'
 #' # bound `x` between 1 and 5

R/coercion.R

@@ -8,6 +8,10 @@
 #' @param x An object to coerce to an array.
 #' @param ... Objects passed on to methods.
 #'
+#' @return
+#'
+#' An array.
+#'
 #' @seealso [as_matrix()]
 #'
 #' @examples
@@ -70,6 +74,10 @@ as.array.vctrs_rray <- as_array.vctrs_rray
 #' @param x An object to coerce to a matrix.
 #' @param ... Objects passed on to methods.
 #'
+#' @return
+#'
+#' A matrix.
+#'
 #' @seealso [as_array()]
 #'
 #' @examples
@@ -160,6 +168,10 @@ validate_matrix_coercible_dim <- function(dim) {
 #'
 #' @param x An object to coerce to an rray.
 #'
+#' @return
+#'
+#' An rray.
+#'
 #' @examples
 #'
 #' as_rray(1)

R/compare.R

@@ -18,6 +18,11 @@
 #' method is used and a warning is thrown. There is nothing we can do about
 #' this. See `?groupGeneric` for more information on this.
 #'
+#' @return
+#'
+#' The value of the comparison, with dimensions identical to the common
+#' dimensions of the inputs.
+#'
 #' @examples
 #' x <- rray(1:12, c(2, 2, 3))
 #' y <- matrix(1:2)

R/compat-vctrs.R

@@ -16,6 +16,10 @@
 #' @param ... Used to pass along error message information.
 #' @inheritParams vec_ptype2
 #'
+#' @return
+#'
+#' See the corresponding vctrs function for the exact return value.
+#'
 #' @name vctrs-compat
 #'
 NULL

R/container-cast.R

@@ -33,20 +33,21 @@
 #' @examples
 #'
 #' # Upcasting to an rray. Still a logical
-#' # vec_cast_container(TRUE, rray(1))
+#' vec_cast_container(TRUE, rray(1))
 #'
 #' # Downcasting to a double, no longer an rray
 #' # (the "container" here is just a base R object)
-#' # vec_cast_container(rray(1), TRUE)
+#' vec_cast_container(rray(1), TRUE)
 #'
 #' # Shape of `x` is kept
-#' # vec_cast_container(matrix(1:5), rray(1))
+#' vec_cast_container(matrix(1:5), rray(1))
 #'
 #' # Dim names of `x` are kept
 #' x <- rray(1:2, dim_names = list(c("r1", "r2")))
-#' # vec_cast_container(x, 1)
+#' vec_cast_container(x, 1)
 #'
 #' @keywords internal
+#' @noRd
 vec_cast_container <- function(x, to) {
 
   if (is.null(x) || is.null(to)) {
@@ -58,14 +59,12 @@ vec_cast_container <- function(x, to) {
 
 # ------------------------------------------------------------------------------
 
-#' @rdname vec_cast_container
 vec_cast_container.default <- function(x, to) {
   stop_incompatible_cast(x, to)
 }
 
 # ------------------------------------------------------------------------------
 
-#' @rdname vec_cast_container
 vec_cast_container.logical <- function(x, to) {
   UseMethod("vec_cast_container.logical")
 }
@@ -92,7 +91,6 @@ vec_cast_container.logical.vctrs_rray <- function(x, to) {
 
 # ------------------------------------------------------------------------------
 
-#' @rdname vec_cast_container
 vec_cast_container.double <- function(x, to) {
   UseMethod("vec_cast_container.double")
 }
@@ -119,7 +117,6 @@ vec_cast_container.double.vctrs_rray <- function(x, to) {
 
 # ------------------------------------------------------------------------------
 
-#' @rdname vec_cast_container
 vec_cast_container.integer <- function(x, to) {
   UseMethod("vec_cast_container.integer")
 }
@@ -146,7 +143,6 @@ vec_cast_container.integer.vctrs_rray <- function(x, to) {
 
 # ------------------------------------------------------------------------------
 
-#' @rdname vec_cast_container
 vec_cast_container.vctrs_rray <- function(x, to) {
   UseMethod("vec_cast_container.vctrs_rray")
 }
@@ -170,7 +166,6 @@ vec_cast_container.vctrs_rray.vctrs_rray <- function(x, to) {
 
 # ------------------------------------------------------------------------------
 
-#' @rdname vec_cast_container
 vec_cast_container_common <- function(..., .to = NULL) {
   args <- list2(...)
   container <- vec_ptype_container_common(!!!args, .ptype = .to)

R/container-type.R

@@ -40,19 +40,20 @@
 #'
 #' @examples
 #' # The container of base R atomics is just logical()
-#' # vec_ptype_container(1)
+#' vec_ptype_container(1)
 #'
 #' # The container of an rray is an empty logical rray
-#' # vec_ptype_container(rray(1))
+#' vec_ptype_container(rray(1))
 #'
 #' # Find the common container of multiple types
 #' # (the rray type is more complex here, and becomes the common container)
-#' # vec_ptype_container_common(1, TRUE, rray(1L))
+#' vec_ptype_container_common(1, TRUE, rray(1L))
 #'
 #' # Not an error!
-#' # vec_ptype_container_common(character(), logical())
+#' vec_ptype_container_common(character(), logical())
 #'
 #' @keywords internal
+#' @noRd
 vec_ptype_container <- function(x) {
 
   if (is.null(x)) {
@@ -84,7 +85,6 @@ vec_ptype_container.vctrs_unspecified <- vec_ptype_container.integer
 
 # ------------------------------------------------------------------------------
 
-#' @rdname vec_ptype_container
 vec_ptype_container_common <- function(..., .ptype = NULL) {
 
   if (!is.null(.ptype)) {

R/container-type2.R

@@ -9,11 +9,12 @@
 #'
 #' @examples
 #'
-#' # vec_ptype_container2(1, 2L)
+#' vec_ptype_container2(1, 2L)
 #'
-#' # vec_ptype_container2(1, rray(2L))
+#' vec_ptype_container2(1, rray(2L))
 #'
 #' @keywords internal
+#' @noRd
 vec_ptype_container2 <- function(x, y) {
 
   if (is.null(x)) {
@@ -29,14 +30,12 @@ vec_ptype_container2 <- function(x, y) {
 
 # ------------------------------------------------------------------------------
 
-#' @rdname vec_ptype_container2
 vec_ptype_container2.default <- function(x, y) {
   stop_incompatible_type(x, y)
 }
 
 # ------------------------------------------------------------------------------
 
-#' @rdname vec_ptype_container2
 vec_ptype_container2.logical <- function(x, y) {
   UseMethod("vec_ptype_container2.logical")
 }
@@ -61,7 +60,6 @@ vec_ptype_container2.logical.vctrs_rray <- function(x, y) {
 
 # ------------------------------------------------------------------------------
 
-#' @rdname vec_ptype_container2
 vec_ptype_container2.integer <- function(x, y) {
   UseMethod("vec_ptype_container2.integer")
 }
@@ -82,7 +80,6 @@ vec_ptype_container2.integer.vctrs_rray <- vec_ptype_container2.logical.vctrs_rr
 
 # ------------------------------------------------------------------------------
 
-#' @rdname vec_ptype_container2
 vec_ptype_container2.double <- function(x, y) {
   UseMethod("vec_ptype_container2.double")
 }
@@ -103,7 +100,6 @@ vec_ptype_container2.double.vctrs_rray <- vec_ptype_container2.logical.vctrs_rra
 
 # ------------------------------------------------------------------------------
 
-#' @rdname vec_ptype_container2
 vec_ptype_container2.character <- function(x, y) {
   UseMethod("vec_ptype_container2.character")
 }
@@ -124,7 +120,6 @@ vec_ptype_container2.character.vctrs_rray <- vec_ptype_container2.logical.vctrs_
 
 # ------------------------------------------------------------------------------
 
-#' @rdname vec_ptype_container2
 vec_ptype_container2.vctrs_rray <- function(x, y) {
   UseMethod("vec_ptype_container2.vctrs_rray")
 }

R/diagonal.R

@@ -12,6 +12,10 @@
 #' @param offset A single integer specifying the offset from the diagonal to
 #' place `x`. This can be positive or negative.
 #'
+#' @return
+#'
+#' A matrix, with `x` on the diagonal.
+#'
 #' @examples
 #' # Creates a diagonal matrix
 #' rray_diag(1:5)

R/dim-n.R

@@ -16,6 +16,10 @@
 #' `dim()` defines a method for data frames that would imply a dimensionality
 #' of 2.
 #'
+#' @return
+#'
+#' An integer vector containing the number of dimensions of `x`.
+#'
 #' @examples
 #' x_1_by_4 <- rray(c(1, 2, 3, 4), c(1, 4))
 #'

R/dim-names-common.R

@@ -21,6 +21,10 @@
 #'
 #' @param x,y,... Objects to find common dimensions for.
 #'
+#' @return
+#'
+#' A list of the common dimension names of the inputs.
+#'
 #' @examples
 #' library(magrittr)
 #'

R/dim-names.R

@@ -43,6 +43,12 @@
 #' @param meta A single character representing an optional "meta" name
 #' assigned to the `axis` names. If `NULL`, the current meta name is kept.
 #'
+#' @return
+#'
+#' `rray_dim_names()` returns a list of dimension names. The other names
+#' functions return character vectors, or `NULL`, corresponding to the
+#' names of a particular axis.
+#'
 #' @name dim-names
 #'
 #' @examples

R/dim.R

@@ -28,6 +28,10 @@
 #'
 #' @param ... Objects to find common dimensions for.
 #'
+#' @return
+#'
+#' An integer vector containing the common dimensions.
+#'
 #' @seealso [rray_dim_n()]
 #'
 #' @examples

R/dot.R

@@ -21,6 +21,11 @@
 #'
 #' @param x,y Arrays or rrays that are either 1D or 2D.
 #'
+#' @return
+#'
+#' The result of the matrix multiplication of `x` and `y`. See `%*%` for the
+#' exact details. The common type of `x` and `y` will be preserved.
+#'
 #' @examples
 #' rray_dot(1:5, 1:5)
 #'