Skip to content

Commit

Permalink
fix website by adding to reference or marking functions as internal
Browse files Browse the repository at this point in the history
  • Loading branch information
egillax committed Jul 23, 2024
1 parent 23ebe03 commit fb31e2f
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 1 deletion.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -73,5 +73,5 @@ Remotes:
ohdsi/BigKnn,
ohdsi/ShinyAppBuilder,
ohdsi/ResultModelManager,
RoxygenNote: 7.3.1
RoxygenNote: 7.3.2
Encoding: UTF-8
6 changes: 6 additions & 0 deletions R/ExternalValidatePlp.R
Original file line number Diff line number Diff line change
Expand Up @@ -550,6 +550,7 @@ validateModel <-
#' checkAllSameInModels - Check if all settings are the same across models
#' @param settingsList A list of settings to check
#' @param settingName The name of the setting to check
#' @keywords internal
checkAllSameInModels <- function(settingsList, settingName) {
if (!Reduce(function(x, y) {
x &&
Expand All @@ -563,6 +564,7 @@ checkAllSameInModels <- function(settingsList, settingName) {
#' extractModelDesigns - Extract all modelDesigns from a list of plpModels
#' @param plpModelList A list of plpModels
#' @return A list of modelDesigns
#' @keywords internal
extractModelDesigns <- function(plpModelList) {
lapply(plpModelList, function(plpModel) {
if (is.character(plpModel)) {
Expand All @@ -582,6 +584,7 @@ extractModelDesigns <- function(plpModelList) {
#' @param logSettings An object of logSettings
#' @param outputFolder The directory to save the validation results to
#' @return A list of inputs that were modified
#' @keywords internal
checkValidateExternalInputs <- function(validationDesignList,
databaseDetails,
logSettings,
Expand Down Expand Up @@ -612,6 +615,7 @@ checkValidateExternalInputs <- function(validationDesignList,
#' @param modelDesigns A list of modelDesign objects
#' @param settingName The name of the setting to check
#' @return The updated design
#' @keywords internal
fromDesignOrModel <- function(validationDesign, modelDesigns, settingName) {
settingsFromModel <- lapply(modelDesigns, function(x) x[[settingName]])
if (is.null(validationDesign[[settingName]])) {
Expand All @@ -634,6 +638,7 @@ fromDesignOrModel <- function(validationDesign, modelDesigns, settingName) {
#' @param outputFolder The directory to save the validation results to
#' @param allCovSettings A list of covariateSettings from the models
#' @return The plpData object
#' @keywords internal
getData <- function(design, database, outputFolder, allCovSettings) {
databaseName <- database$cdmDatabaseName
plpDataName <-
Expand Down Expand Up @@ -674,6 +679,7 @@ getData <- function(design, database, outputFolder, allCovSettings) {
#' @param modelDesigns A list of modelDesign objects
#' @param plpData The plpData object
#' @return The population dataframe
#' @keywords internal
getPopulation <- function(validationDesign, modelDesigns, plpData) {
design <- fromDesignOrModel(validationDesign, modelDesigns, "populationSettings")
population <- tryCatch({
Expand Down
2 changes: 2 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -269,5 +269,7 @@ reference:
- title: "Other functions"
contents:
- predictCyclops
- predictGlm
- createGlmModel


1 change: 1 addition & 0 deletions man/checkAllSameInModels.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/checkValidateExternalInputs.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/extractModelDesigns.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/fromDesignOrModel.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/getData.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/getPopulation.Rd

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

0 comments on commit fb31e2f

Please sign in to comment.