Skip to content

Commit

Permalink
Small edits in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nfrerebeau committed Nov 21, 2024
1 parent 0932add commit 45d4b43
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 18 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Suggests:
Encoding: UTF-8
LazyData: true
Roxygen: list(markdown = TRUE)
RoxygenNote: 7.2.3
RoxygenNote: 7.3.2
Collate:
'AllGenerics.R'
'coordinates.R'
Expand Down
17 changes: 8 additions & 9 deletions R/AllGenerics.R
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,8 @@
#' @return
#' A [`list`] with the components:
#' \tabular{ll}{
#' `x` \tab A [`numeric`] vector of x values. \cr
#' `y` \tab A [`numeric`] vector of y values. \cr
#' `z` \tab A [`numeric`] vector of z values. \cr
#' `x` \tab A [`numeric`] vector of x coordinates. \cr
#' `y` \tab A [`numeric`] vector of y coordinates. \cr
#' `center` \tab A [`numeric`] vector giving the center. \cr
#' `scale` \tab A [`numeric`] vector giving the scale factor. \cr
#' }
Expand Down Expand Up @@ -52,9 +51,9 @@ setGeneric(
#' @return
#' A [`list`] with the components:
#' \tabular{ll}{
#' `x` \tab A [`numeric`] vector of x values. \cr
#' `y` \tab A [`numeric`] vector of y values. \cr
#' `z` \tab A [`numeric`] vector of z values. \cr
#' `x` \tab A [`numeric`] vector of x coordinates. \cr
#' `y` \tab A [`numeric`] vector of y coordinates. \cr
#' `z` \tab A [`numeric`] vector of z coordinates. \cr
#' }
#' @example inst/examples/ex-coordinates.R
#' @author N. Frerebeau
Expand All @@ -64,7 +63,7 @@ setGeneric(
#' @keywords internal
setGeneric(
name = "coordinates_cartesian",
def = function(x, y, z, ...) standardGeneric("coordinates_cartesian"),
def = function(x, y, ...) standardGeneric("coordinates_cartesian"),
valueClass = "list"
)

Expand Down Expand Up @@ -605,10 +604,10 @@ setGeneric(
#' Invisibly returns a [`list`] with elements `levels` (the contour levels) and
#' `colors` (the contour colors) that can be used for a legend.
#' @note
#' Two-dimensional kernel density estimation is adapted from [`MASS::kde2d()`].
#'
#' **This must be considered as experimental and subject to major changes
#' in a future release.**
#' @source
#' Two-dimensional kernel density estimation is adapted from [`MASS::kde2d()`].
#' @seealso [grDevices::contourLines()]
#' @example inst/examples/ex-density.R
#' @author N. Frerebeau
Expand Down
8 changes: 4 additions & 4 deletions man/coordinates_cartesian.Rd

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

5 changes: 2 additions & 3 deletions man/coordinates_ternary.Rd

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

1 change: 0 additions & 1 deletion man/isopleuros-package.Rd

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

0 comments on commit 45d4b43

Please sign in to comment.