Update CI documentation

OHDSI · Sep 20, 2024 · e7c7506 · e7c7506
1 parent 04130ca
commit e7c7506
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 12 deletions.
diff --git a/extras/rdms/schema_meta.xml b/extras/rdms/schema_meta.xml
@@ -505,16 +505,16 @@
       <column name="gender_id" comments="Gender identifier"/>
       <column name="gender_name" comments="Gender name"/>
       <column name="start_year" comments="Start year"/>
-      <column name="persons_at_risk_pe" comments="Persons at risk pre-exposure"/>
+      <column name="persons_at_risk_pe" comments="Persons at risk pre-exclude (counts before excluding time at risk)"/>
       <column name="persons_at_risk" comments="Persons at risk"/>
-      <column name="person_days_pe" comments="Person days pre-exposure"/>
+      <column name="person_days_pe" comments="Person days pre-exclude (counts before excluding time at risk)"/>
       <column name="person_days" comments="Person days"/>
-      <column name="person_outcomes_pe" comments="Person outcomes pre-exposure"/>
+      <column name="person_outcomes_pe" comments="Person outcomes pre-exclude (counts before excluding time at risk)"/>
       <column name="person_outcomes" comments="Person outcomes"/>
-      <column name="outcomes_pe" comments="Outcomes pre-expsoure"/>
+      <column name="outcomes_pe" comments="Outcomes pre-exclude (counts before excluding time at risk)"/>
       <column name="outcomes" comments="Outcomes"/>
-      <column name="incidence_proportion_p100p" comments="Incidence proportion"/>
-      <column name="incidence_rate_p100py" comments="Incidence rate"/>
+      <column name="incidence_proportion_p100p" comments="Incidence proportion (person_outcomes / persons_at_risk) per 100 people"/>
+      <column name="incidence_rate_p100py" comments="Incidence rate (outcomes / time_at_risk) per 100 person years"/>
     </table>
     <table name="ci_target_def" comments="CohortIncidenceModule: Target cohort definitions">
       <column name="ref_id" comments="The reference identifier for the analysis"/>

diff --git a/inst/csv/cohortIncidenceRdms.csv b/inst/csv/cohortIncidenceRdms.csv
@@ -10,16 +10,16 @@ incidence_summary,age_group_id,int,no,no,Age group identifier
 incidence_summary,gender_id,int,no,no,Gender identifier
 incidence_summary,gender_name,varchar(255),no,no,Gender name
 incidence_summary,start_year,int,no,no,Start year
-incidence_summary,persons_at_risk_pe,bigint,no,no,Persons at risk pre-exposure
+incidence_summary,persons_at_risk_pe,bigint,no,no,Persons at risk pre-exclude (counts before excluding time at risk)
 incidence_summary,persons_at_risk,bigint,no,no,Persons at risk
-incidence_summary,person_days_pe,bigint,no,no,Person days pre-exposure
+incidence_summary,person_days_pe,bigint,no,no,Person days pre-exclude (counts before excluding time at risk)
 incidence_summary,person_days,bigint,no,no,Person days
-incidence_summary,person_outcomes_pe,bigint,no,no,Person outcomes pre-exposure
+incidence_summary,person_outcomes_pe,bigint,no,no,Person outcomes pre-exclude (counts before excluding time at risk)
 incidence_summary,person_outcomes,bigint,no,no,Person outcomes
-incidence_summary,outcomes_pe,bigint,no,no,Outcomes pre-expsoure
+incidence_summary,outcomes_pe,bigint,no,no,Outcomes pre-exclude (counts before excluding time at risk)
 incidence_summary,outcomes,bigint,no,no,Outcomes
-incidence_summary,incidence_proportion_p100p,float,no,no,Incidence proportion
-incidence_summary,incidence_rate_p100py,float,no,no,Incidence rate
+incidence_summary,incidence_proportion_p100p,float,no,no,Incidence proportion (person_outcomes / persons_at_risk) per 100 people
+incidence_summary,incidence_rate_p100py,float,no,no,Incidence rate (outcomes / time_at_risk) per 100 person years
 target_def,ref_id,int,yes,yes,The reference identifier for the analysis
 target_def,target_cohort_definition_id,bigint,yes,yes,Target cohort identifier
 target_def,target_name,varchar(255),no,no,Target cohort name