Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
egillax committed Jan 27, 2025
1 parent a99651c commit aa6ebe9
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 4 deletions.
3 changes: 3 additions & 0 deletions R/ExtractData.R
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,7 @@ getPlpData <- function(

#' Print a plpData object
#' @method print plpData
#' @param x The plpData object to print
#' @return A message describing the object
#' @export
print.plpData <- function(x, ...) {
Expand All @@ -448,6 +449,7 @@ print.plpData <- function(x, ...) {

#' Summarize a plpData object
#' @method summary plpData
#' @param object The plpData object to summarize'
#' @return A summary of the object containing the number of people, outcomes and covariates
#' @export
summary.plpData <- function(object, ...) {
Expand Down Expand Up @@ -477,6 +479,7 @@ summary.plpData <- function(object, ...) {
#' Print a summary.plpData object
#' @export
#' @method print summary.plpData
#' @param x The summary.plpData object to print
#' @return A message describing the object
print.summary.plpData <- function(x, ...) {
writeLines("plpData object summary")
Expand Down
3 changes: 1 addition & 2 deletions R/SklearnClassifierHelpers.R
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@
#' @param allList a list of lists
#' @return A list with all possible combinations from the input list of lists
#' @examples
#' results <- listCartesian(list(list(1, 2), list(3, 4))
#' results
#' listCartesian(list(list(1, 2), list(3, 4))
#' @export
listCartesian <- function(allList) {
combinations <- expand.grid(allList)
Expand Down
3 changes: 1 addition & 2 deletions man/listCartesian.Rd

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

3 changes: 3 additions & 0 deletions man/print.plpData.Rd

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

3 changes: 3 additions & 0 deletions man/print.summary.plpData.Rd

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

3 changes: 3 additions & 0 deletions man/summary.plpData.Rd

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

0 comments on commit aa6ebe9

Please sign in to comment.