Skip to content

Commit 0ece08d

Browse files
committed
Fix docs
1 parent 2eaa138 commit 0ece08d

19 files changed

+31
-21
lines changed

R/class-AbundanceDensityPlot.R

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
#' \item \code{order_descending}, a string specifying the descending order.
1616
#' }
1717
#'
18-
#' In addition, this class inherits all slots from its parent \linkS4class{Panel} class.
18+
#' In addition, this class inherits all slots from its parent class
19+
#' \code{\link[iSEE:Panel-class]{Panel}}.
1920
#'
2021
#' @return
2122
#' The \code{AbundanceDensityPlot(...)} constructor creates an instance of an

R/class-AbundancePlot.R

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313
#' \item \code{add_legend}, a logical indicating if the color legend should appear.
1414
#' }
1515
#'
16-
#' In addition, this class inherits all slots from its parent \linkS4class{Panel} class.
16+
#' In addition, this class inherits all slots from its parent class
17+
#' \code{\link[iSEE:Panel-class]{Panel}}.
1718
#'
1819
#' @return
1920
#' The \code{AbundancePlot(...)} constructor creates an instance of an

R/class-LoadingPlot.R

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414
#' \item \code{add.tree}, a logical indicating whether the tree should be shown.
1515
#' }
1616
#'
17-
#' In addition, this class inherits all slots from its parent \linkS4class{Panel} class.
17+
#' In addition, this class inherits all slots from its parent class
18+
#' \code{\link[iSEE:Panel-class]{Panel}}.
1819
#'
1920
#' @return
2021
#' The \code{LoadingPlot(...)} constructor creates an instance of an

R/class-RDAPlot.R

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@
3030
#' on the coordinate axes.
3131
#' }
3232
#'
33-
#' In addition, this class inherits all slots from its parent \linkS4class{Panel} class.
33+
#' In addition, this class inherits all slots from its parent class
34+
#' \code{\link[iSEE:Panel-class]{Panel}}.
3435
#'
3536
#' @return
3637
#' The \code{RDAPlot(...)} constructor creates an instance of a RDAPlot class,

R/class-ScreePlot.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@
4545
#' (Default: \code{c("eig", "varExplained")})
4646
#' }
4747
#'
48-
#' In addition, this class inherits all slots from its parent
49-
#' \linkS4class{Panel} class.
48+
#' In addition, this class inherits all slots from its parent class
49+
#' \code{\link[iSEE:Panel-class]{Panel}}.
5050
#'
5151
#' @return
5252
#' The \code{ScreePlot(...)} constructor creates an instance of an ScreePlot

R/family-GraphPlot.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
#' }
3636
#'
3737
#' In addition, this class inherits all slots from its parent class
38-
#' \linkS4class{Panel}.
38+
#' \code{\link[iSEE:Panel-class]{Panel}}.
3939
#'
4040
#' @seealso
4141
#' \linkS4class{RowGraphPlot}

R/family-TreePlot.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
#' }
4242
#'
4343
#' In addition, this class inherits all slots from its parent
44-
#' \linkS4class{Panel} class.
44+
#' \code{\link[iSEE:Panel-class]{Panel}}.
4545
#'
4646
#' @seealso
4747
#' \linkS4class{RowTreePlot}

R/iSEEtree-package.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#' iSEE extension for the TreeSummarizedExperiment container
22
#'
3-
#' `iSEEtree` is an extension of \pkg{iSEE} that provides panels for the
3+
#' \code{iSEEtree} is an extension of \pkg{iSEE} that provides panels for the
44
#' \code{\link[TreeSummarizedExperiment:TreeSummarizedExperiment-constructor]{TreeSummarizedExperiment}}
55
#' container, enabling the interactive visualisation of typical microbiome data.
66
#' The panel layout of iSEEtree is described in \code{\link{iSEE}}.
@@ -14,6 +14,6 @@
1414
#'
1515
#' @docType package
1616
#' @keywords internal
17-
#' @name iSEEtree
17+
#' @name iSEEtree-package
1818
#'
1919
"_PACKAGE"

R/utils.R

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
#' # View filtered list of panels
3030
#' initial
3131
#'
32+
#' @keywords internal
3233
#' @name utils
3334
NULL
3435

man/AbundanceDensityPlot.Rd

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/AbundancePlot.Rd

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/GraphPlot.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/LoadingPlot.Rd

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/RDAPlot.Rd

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/ScreePlot.Rd

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

man/TreePlot.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/iSEEtree.Rd renamed to man/iSEEtree-package.Rd

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

man/utils.Rd

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

pkgdown/_pkgdown.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ reference:
3131
- utils
3232
- subtitle: Package
3333
- contents:
34-
- iSEEtree
34+
- iSEEtree-package

0 commit comments

Comments
 (0)