Skip to content

Commit

Permalink
Add @Keywords internal to internal functions
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesmbaazam committed Mar 21, 2024
1 parent feb756d commit 28dd412
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
5 changes: 0 additions & 5 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,6 @@ S3method(print,epichains_summary)
S3method(summary,epichains)
S3method(summary,epichains_summary)
S3method(tail,epichains)
export(.epichains)
export(.is_epichains)
export(.is_epichains_summary)
export(.validate_epichains)
export(.validate_epichains_summary)
export(dborel)
export(likelihood)
export(rborel)
Expand Down
10 changes: 5 additions & 5 deletions R/epichains.R
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
#'
#' @return An `<epichains>` object
#' @author James M. Azam
#' @export
#' @keywords internal
.epichains <- function(tree_df,
index_cases,
offspring_dist,
Expand Down Expand Up @@ -430,7 +430,7 @@ summary.epichains_summary <- function(object, ...) {
#' @return logical, `TRUE` if the object is an `<epichains>` and `FALSE`
#' otherwise
#' @author James M. Azam
#' @export
#' @keywords internal
.is_epichains <- function(x) {
inherits(x, "epichains")
}
Expand All @@ -442,7 +442,7 @@ summary.epichains_summary <- function(object, ...) {
#' @return logical, `TRUE` if the object is an `epichains_summary` and `FALSE`
#' otherwise
#' @author James M. Azam
#' @export
#' @keywords internal
.is_epichains_summary <- function(x) {
inherits(x, "epichains_summary")
}
Expand All @@ -453,7 +453,7 @@ summary.epichains_summary <- function(object, ...) {
#'
#' @return No return.
#' @author James M. Azam
#' @export
#' @keywords internal
.validate_epichains <- function(x) {
if (!.is_epichains(x)) {
stop("Object must have an `<epichains>` class")
Expand Down Expand Up @@ -481,7 +481,7 @@ summary.epichains_summary <- function(object, ...) {
#'
#' @return No return.
#' @author James M. Azam
#' @export
#' @keywords internal
.validate_epichains_summary <- function(x) {
if (!.is_epichains_summary(x)) {
stop("Object must have an `<epichains_summary>` class")
Expand Down
1 change: 1 addition & 0 deletions man/dot-epichains.Rd

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

1 change: 1 addition & 0 deletions man/dot-is_epichains.Rd

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

1 change: 1 addition & 0 deletions man/dot-is_epichains_summary.Rd

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

1 change: 1 addition & 0 deletions man/dot-validate_epichains.Rd

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

1 change: 1 addition & 0 deletions man/dot-validate_epichains_summary.Rd

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

0 comments on commit 28dd412

Please sign in to comment.