Skip to content

Commit

Permalink
minor edits to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mjskay committed Jan 8, 2024
1 parent ca67b6e commit 739a5b4
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions R/rvar-.R
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,13 @@
#'
#' - `draws`: An [`array`] containing the draws, where the first dimension
#' indexes draws. **Always** get this attribute using [draws_of()] and set it
#' using `draws_of(x) <- value`. To simplify programming, `dim(draws_of(x))`
#' using `draws_of(x) <- value`. To simplify programming, `length(dim(draws_of(x)))`
#' is guaranteed to always be greater than or equal to 2. Zero-length `rvar`s
#' have `dim(draws_of(x)) = c(1,0)`. The draws may be a [`numeric`],
#' [`integer`], [`logical`], [`factor`], or [`ordered`] array.
#'
#' The dimensions after the first are reported as the dimensions of `x`; i.e.
#' `dim(x) == dim(draws_of(x))[-1]` and `dimnames(x) = dimnames(draws_of(x))[-1]`.
#' `dim(x) = dim(draws_of(x))[-1]` and `dimnames(x) = dimnames(draws_of(x))[-1]`.
#' Because `rvar`s *always* have dimensions (unlike base R datatypes, where
#' there is a distinction between a length-*n* vector with no dimensions and
#' a length-*n* array with only 1 dimension), `names(x) = dimnames(x)[[1]]`;
Expand All @@ -95,7 +95,7 @@
#' - `nchains`: A scalar [`numeric`] giving the number of chains in this `rvar`.
#' **Always** get this attribute using [nchains()]. It cannot be set using the
#' public (exported) API, but can be modified through other functions (e.g.
#' [merge_chains()] or creating a new [rvar()]). In internal code, **always**
#' [merge_chains()] or by creating a new [rvar()]). In internal code, **always**
#' set it using `nchains_rvar(x) <- value`.
#'
#' - `log_weights`: A vector [`numeric`] with length `ndraws(x)` giving the
Expand All @@ -106,7 +106,7 @@
#'
#' - `cache`: An [`environment`] that may contain cached output of the \pkg{vctrs}
#' proxy functions on `x` to improve performance of code that makes multiple
#' calls to these functions. The cache is updated automatically and invalidated
#' calls to those functions. The cache is updated automatically and invalidated
#' when necessary so long as the `rvar` is only modified using the functions
#' described in this section (or other functions in the publicly-exported
#' `rvar` API). The environment may contain these variables:
Expand Down
8 changes: 4 additions & 4 deletions man/rvar.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 739a5b4

Please sign in to comment.