Skip to content

Commit 89bb9d9

Browse files
committed
fixing docs
1 parent 41145a0 commit 89bb9d9

33 files changed

+77
-119
lines changed

NAMESPACE

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Generated by roxygen2: do not edit by hand
22

3-
export(.getCgVersion)
43
export(addTarColumn)
54
export(createPredictionReport)
65
export(formatBinaryCovariateName)

R/CohortQueries.R

Lines changed: 3 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,3 @@
1-
#' An internal function to determine the version of CohortGenerator is
2-
#' used to store results
3-
#'
4-
#' @details
5-
#' Specify the connectionHandler, the schema and the prefixes. This
6-
#' query will attempt to identify if CohortGenerator v0.x was used by
7-
#' inspecing the migration table. When the migration_order is >= 3
8-
#' then v1 of CohortGenerator was used.
9-
#'
10-
#' @template connectionHandler
11-
#' @template schema
12-
#' @template cgTablePrefix
13-
#' @family Estimation
14-
#'
15-
#' @return
16-
#' A integer with the major version number of CohortGenerator
17-
#'
18-
#' @examples
19-
#' conDet <- getExampleConnectionDetails()
20-
#'
21-
#' connectionHandler <- ResultModelManager::ConnectionHandler$new(conDet)
22-
#'
23-
#' version <- .getCgVersion(
24-
#' connectionHandler = connectionHandler,
25-
#' schema = 'main'
26-
#' )
27-
#'
28-
#' @export
291
.getCgVersion <- function(
302
connectionHandler,
313
schema,
@@ -633,6 +605,7 @@ getCohortSubsetAttrition <- function(
633605
#' Function processes the cohortDefinitions object by adding friendly names for
634606
#' specified parent cohorts, determines which cohorts are nested in the specified
635607
#' indication cohort ids and ...
608+
#' @family Cohorts
636609
#'
637610
#' @param cohortDefinitions The output of `getCohortDefinitions()`
638611
#' @param friendlyCohortIds a vector of parent cohort ids that you want to rename
@@ -696,6 +669,7 @@ processCohortDefinitionsForQuarto <- function(
696669
#' @details
697670
#' This function finds the targets, comparators, indications and outcomes of interest based
698671
#' on the user inputs for quarto report generation.
672+
#' @family Cohorts
699673
#'
700674
#' @template connectionHandler
701675
#' @template schema
@@ -851,6 +825,7 @@ subsetNestedInIds <- function(subsetDefinitionJson = NULL, nestIds){
851825
#' @details
852826
#' The function takes a subsetDefinitionJson and converts it into friendly text describing the
853827
#' subset logic
828+
#' @family Cohorts
854829
#'
855830
#' @param subsetDefinitionJson The subset logic json
856831
#' @param cohortDefinitions A data.frame with the columns cohortDefinitionId, cohortName and optionally friendlyName that will

man/dot-getCgVersion.Rd

Lines changed: 0 additions & 63 deletions
This file was deleted.

man/getCMEstimation.Rd

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

man/getCmDiagnosticsData.Rd

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

man/getCmMetaEstimation.Rd

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

man/getCmNegativeControlEstimates.Rd

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

man/getCmOutcomes.Rd

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

man/getCmPropensityModel.Rd

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

man/getCmTable.Rd

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

0 commit comments

Comments
 (0)