Package: OhdsiReportGenerator 2.2.0

Jenna Reps

OhdsiReportGenerator: Observational Health Data Sciences and Informatics Report Generator

Extract results into R from the Observational Health Data Sciences and Informatics result database (see <https://ohdsi.github.io/Strategus/results-schema/index.html>) and generate reports/presentations via 'quarto' that summarize results in HTML format. Learn more about 'OhdsiReportGenerator' at <https://ohdsi.github.io/OhdsiReportGenerator/>.

Authors:Jenna Reps [aut, cre], Anthony Sena [aut]

OhdsiReportGenerator_2.2.0.tar.gz
OhdsiReportGenerator_2.2.0.tar.gz(r-4.7-any)OhdsiReportGenerator_2.2.0.tar.gz(r-4.6-any)
OhdsiReportGenerator_2.2.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html
card.svg |card.png
OhdsiReportGenerator/json (API)

# Install 'OhdsiReportGenerator' in R:
install.packages('OhdsiReportGenerator', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/ohdsi/ohdsireportgenerator/issues

Pkgdown/docs site:https://ohdsi.github.io

Uses libs:
  • openjdk– OpenJDK Java runtime, using Hotspot JIT

On CRAN:

Conda:

quartoopenjdk

2.48 score 5 scripts 722 downloads 88 exports 104 dependencies

Last updated from:fc03bf73e6. Checks:4 OK. Indexed: no.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK192
source / vignettesOK196
linux-release-x86_64OK192
wasm-releaseOK134

Exports:addTarColumncreateCharacterizationIndexescreateCohortIndexescreateIncidenceIndexescreatePredictionReportcreateSccsIndexesformatBinaryCovariateNamegenerateFullReportgenerateSummaryPredictionReportgetAnalysisCohortsgetBinaryCaseSeriesgetBinaryRiskFactorsgetBinaryTargetBaselinegetCaseCountsgetCaseTargetCountsgetCharacterizationCohortBinarygetCharacterizationCohortContinuousgetCharacterizationDemographicsgetCharacterizationOutcomesgetCharacterizationTargetsgetCmDiagnosticsDatagetCMEstimationgetCmMetaEstimationgetCmNegativeControlEstimatesgetCmOutcomesgetCmPropensityModelgetCmTablegetCmTargetsgetCohortAttritiongetCohortCountsgetCohortDefinitionsgetCohortInclusionRulesgetCohortInclusionStatsgetCohortInclusionSummarygetCohortMetagetCohortSubsetAttritiongetCohortSubsetDefinitionsgetContinuousCaseSeriesgetContinuousRiskFactorsgetDatabaseDetailsgetDechallengeRechallengegetDechallengeRechallengeFailsgetEventDurationgetExampleConnectionDetailsgetFullPredictionPerformancesgetIncidenceOutcomesgetIncidenceRatesgetIncidenceTargetsgetOutcomeTablegetPredictionAggregateTopPredictorsgetPredictionCohortsgetPredictionCovariatesgetPredictionDiagnosticsgetPredictionDiagnosticTablegetPredictionHyperParamSearchgetPredictionInterceptgetPredictionLiftgetPredictionModelDesignsgetPredictionOutcomesgetPredictionPerformancesgetPredictionPerformanceTablegetPredictionTargetsgetPredictionTopPredictorsgetSccsDiagnosticsDatagetSccsEstimationgetSccsMetaEstimationgetSccsModelgetSccsNegativeControlEstimatesgetSccsOutcomesgetSccsTablegetSccsTargetsgetSccsTimeToEventgetSubsetTextgetTargetBinaryFeaturesgetTargetContinuousFeaturesgetTargetTablegetTimeToEventgetTreatmentPathwayskableDarkplotAgeDistributionsplotCmEstimatesplotSccsEstimatesplotSexDistributionsprocessCohortDefinitionsForQuartoprocessCohortsremoveSpacesrestrictCohortDefinitionsForQuartoviewIncidenceRate

Dependencies:backportsbase64encbigDbitbit64bitopsblobbslibcachemcheckmateCirceRclicliprcommonmarkcpp11crayoncurlDatabaseConnectorDBIdbplyrdigestdplyrevaluatefarverfastmapfontawesomeforestploterfsgenericsggplot2gluegridExtragtgtablegtExtrashighrhmshtmltoolshtmlwidgetsisobandjquerylibjsonlitejuicyjuicekableExtraknitrlabelinglaterlifecyclelitedownmagrittrmarkdownmemoisememusemimepaletteerParallelLoggerpillarpkgconfigprettyunitsprismaticprocessxprogresspspurrrquartoR6rappdirsRColorBrewerRcppreactablereactRreadrrematch2rJavaRJSONIOrlangrmarkdownrstudioapiS7sassscalessnowSqlRenderstringistringrsvglitesystemfontstextshapingtibbletidyrtidyselecttinytextriebeardtzdburltoolsutf8V8vctrsviridisLitevroomwithrxfunxml2yaml

Using Observational Health Data Sciences and Informatics (OHDSI) Report Generator

Rendered fromExampleCode.Rmdusingknitr::knitron Jun 16 2026.

Last update: 2026-05-17
Started: 2025-02-26

Readme and manuals

Help Manual

Help pageTopics
An internal function to determine the version of CohortMethod used to store results.getCmVersion
An internal function to determine the version of SCCS used to store results.getSccsVersion
addTarColumnaddTarColumn
A function to add indexes to the Characterization resultscreateCharacterizationIndexes
A function to add indexes to the Cohort Generator resultscreateCohortIndexes
A function to add indexes to the incidence resultscreateIncidenceIndexes
createPredictionReportcreatePredictionReport
A function to add indexes to the SCCS resultscreateSccsIndexes
formatBinaryCovariateNameformatBinaryCovariateName
generateFullReportgenerateFullReport
generateSummaryPredictionReportgenerateSummaryPredictionReport
Extracts the different analyses ran for each target and event cohortsgetAnalysisCohorts
A function to extract case series characterization resultsgetBinaryCaseSeries
A function to extract non-case and case binary characterization resultsgetBinaryRiskFactors
Extract the aggregate covariates for the target ids of interestgetBinaryTargetBaseline
Extract the outcome cohort counts resultgetCaseCounts
Extract the target cohort counts resultgetCaseTargetCounts
A function to extract cohort aggregate binary feature characterization resultsgetCharacterizationCohortBinary
A function to extract cohort aggregate continuous feature characterization resultsgetCharacterizationCohortContinuous
Extract the binary age groups for the cases and targetsgetCharacterizationDemographics
A function to extract the outcomes found in characterizationgetCharacterizationOutcomes
A function to extarct the targets found in characterizationgetCharacterizationTargets
Extract the cohort method diagostic resultsgetCmDiagnosticsData
Extract the cohort method resultsgetCMEstimation
Extract the cohort method meta analysis resultsgetCmMetaEstimation
Extract the cohort method negative controlsgetCmNegativeControlEstimates
A function to extract the outcomes found in cohort methodgetCmOutcomes
Extract the cohort method modelgetCmPropensityModel
Extract the cohort method table specifiedgetCmTable
A function to extract the targets found in cohort methodgetCmTargets
Get cohort attritiongetCohortAttrition
Extract the cohort countsgetCohortCounts
Extract the cohort definition detailsgetCohortDefinitions
Extract the cohort inclusion rulesgetCohortInclusionRules
Extract the cohort inclusion statsgetCohortInclusionStats
Extract the cohort inclusion summarygetCohortInclusionSummary
Extract the cohort metagetCohortMeta
Get cohort subset attritiongetCohortSubsetAttrition
Extract the cohort subset definition detailsgetCohortSubsetDefinitions
A function to extract case series continuous feature characterization resultsgetContinuousCaseSeries
A function to extract non-case and case continuous characterization resultsgetContinuousRiskFactors
Extract the database used in the analysesgetDatabaseDetails
Extract the dechallenge rechallenge resultsgetDechallengeRechallenge
A function to extract the failed dechallenge-rechallenge casesgetDechallengeRechallengeFails
Extracts summary of event durationgetEventDuration
create a connection detail for an example OHDSI results databasegetExampleConnectionDetails
Extract the model performances per evaluationgetFullPredictionPerformances
A function to extract the outcomes found in incidencegetIncidenceOutcomes
Extract the cohort incidence resultgetIncidenceRates
A function to extract the targets found in incidencegetIncidenceTargets
Extract the outcome cohorts and where they are used in the analyses.getOutcomeTable
Extract the top N predictors across a set of modelsgetPredictionAggregateTopPredictors
Extract a complete set of cohorts used in the prediction resultsgetPredictionCohorts
Extract covariate summary detailsgetPredictionCovariates
Extract the model design diagnostics for a specific development databasegetPredictionDiagnostics
Extract specific diagnostic tablegetPredictionDiagnosticTable
Extract hyper parameters detailsgetPredictionHyperParamSearch
Extract model interception (for logistic regression)getPredictionIntercept
Extract model lift at given model sensitivitygetPredictionLift
Extract the model designs from the prediction resultsgetPredictionModelDesigns
A function to extract the outcomes found in predictiongetPredictionOutcomes
Extract the model performancesgetPredictionPerformances
Extract specific results tablegetPredictionPerformanceTable
A function to extarct the targets found in predictiongetPredictionTargets
Extract the top N predictors per modelgetPredictionTopPredictors
Extract the self controlled case series (sccs) diagostic resultsgetSccsDiagnosticsData
Extract the self controlled case series (sccs) resultsgetSccsEstimation
Extract the self controlled case series (sccs) meta analysis resultsgetSccsMetaEstimation
Extract the SCCS model tablegetSccsModel
Extract the SCCS negative controlsgetSccsNegativeControlEstimates
A function to extract the outcomes found in self controlled case seriesgetSccsOutcomes
Extract the SCCS table specifiedgetSccsTable
A function to extract the targets found in self controlled case seriesgetSccsTargets
Extract the SCCS time-to-eventgetSccsTimeToEvent
Function that converts a subsetDefinitionJson into text descriptiongetSubsetText
Extract aggregate statistics of binary feature analysis IDs of interest for targets (ignoring excluding people with prior outcome)getTargetBinaryFeatures
Extract aggregate statistics of continuous feature analysis IDs of interest for targetsgetTargetContinuousFeatures
Extract the target cohorts and where they are used in the analyses.getTargetTable
Extract the time to event resultgetTimeToEvent
Extracts treatment pathwaysgetTreatmentPathways
output a nicely formatted html tablekableDark
OhdsiReportGeneratorOhdsiReportGenerator-package OhdsiReportGenerator
Plots the age distributions using the binary age groupsplotAgeDistributions
Plots the cohort method results for one analysisplotCmEstimates
Plots the self controlled case series results for one analysisplotSccsEstimates
Plots the sex distributions using the sex featuresplotSexDistributions
Function processes the cohortDefinitions object ready for use in the main quarto report.processCohortDefinitionsForQuarto
Extract the cohort parents and children cohorts (cohorts derieved from the parent cohort)processCohorts
removeSpacesremoveSpaces
Function to figure out the target, comparator, outcome and indication ids of interest for the quarto report based on the user inputsrestrictCohortDefinitionsForQuarto
View the Incidence RatesviewIncidenceRate