Skip to content

Commit

Permalink
Merge pull request #57 from RTIInternational/human-readable-r-func_do…
Browse files Browse the repository at this point in the history
…cumentation-update

Added stuff so I could put links to topmed docs
  • Loading branch information
Sigfried authored Jan 21, 2025
2 parents 2a4a0d4 + 604002b commit 01c286f
Show file tree
Hide file tree
Showing 12 changed files with 113 additions and 82 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<a id="cac_score_1"></a>
## atherosclerosis: **cac_score_1** (cac_score)
Coronary artery calcification (CAC) score using Agatston scoring of CT scan(s) of coronary arteries
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [CHS](#cac_score_1-chs)
* [JHS](#cac_score_1-jhs)
* **Metadata**:
Expand Down Expand Up @@ -105,7 +105,7 @@
<a id="cac_volume_1"></a>
## atherosclerosis: **cac_volume_1** (cac_volume)
Coronary artery calcium volume using CT scan(s) of coronary arteries
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [FHS](#cac_volume_1-fhs)
* **Metadata**:
**`Data Type`**: decimal, **`Measurement Units`**: cubic millimeters, **`Version`**: 1, **`Has Age Variable`**: Yes, **`Date Harmonized`**: 2017-10-30 17:31:30
Expand Down Expand Up @@ -164,7 +164,7 @@
<a id="carotid_plaque_1"></a>
## atherosclerosis: **carotid_plaque_1** (carotid_plaque)
Presence or absence of carotid plaque.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#carotid_plaque_1-aric)
* [CHS](#carotid_plaque_1-chs)
* [JHS](#carotid_plaque_1-jhs)
Expand Down Expand Up @@ -367,7 +367,7 @@
<a id="carotid_stenosis_1"></a>
## atherosclerosis: **carotid_stenosis_1** (carotid_stenosis)
Extent of narrowing of the carotid artery.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [CHS](#carotid_stenosis_1-chs)
* [FHS](#carotid_stenosis_1-fhs)
* [MESA](#carotid_stenosis_1-mesa)
Expand Down Expand Up @@ -562,7 +562,7 @@
<a id="cimt_1"></a>
## atherosclerosis: **cimt_1** (cimt)
Common carotid intima-media thickness, calculated as the mean of two values: mean of multiple thickness estimates from the left far wall and from the right far wall.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#cimt_1-aric)
* [CHS](#cimt_1-chs)
* [FHS](#cimt_1-fhs)
Expand Down Expand Up @@ -750,7 +750,7 @@
<a id="cimt_2"></a>
## atherosclerosis: **cimt_2** (cimt)
Common carotid intima-media thickness, calculated as the mean of four values: maximum of multiple thickness estimates from the left far wall, left near wall, right far wall, and right near wall.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#cimt_2-aric)
* [CHS](#cimt_2-chs)
* [FHS](#cimt_2-fhs)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a id="angina_incident_1"></a>
## atherosclerosis_events_incident: **angina_incident_1** (angina_incident)
An indicator of whether a subject had an angina event (that was verified by adjudication or by medical professionals) during the follow-up period.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [FHS](#angina_incident_1-fhs)
* [WHI](#angina_incident_1-whi)
* **Metadata**:
Expand Down Expand Up @@ -159,7 +159,7 @@
<a id="cabg_incident_1"></a>
## atherosclerosis_events_incident: **cabg_incident_1** (cabg_incident)
An indicator of whether a subject had a coronary artery bypass graft (CABG) procedure (that was verified by adjudication or by medical professionals) during the follow-up period.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [FHS](#cabg_incident_1-fhs)
* [WHI](#cabg_incident_1-whi)
* **Metadata**:
Expand Down Expand Up @@ -294,7 +294,7 @@
<a id="cad_followup_start_age_1"></a>
## atherosclerosis_events_incident: **cad_followup_start_age_1** (cad_followup_start_age)
Age of subject at the start of the follow-up period during which atherosclerosis events were reviewed and adjudicated.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [FHS](#cad_followup_start_age_1-fhs)
* [WHI](#cad_followup_start_age_1-whi)
* **Metadata**:
Expand Down Expand Up @@ -345,7 +345,7 @@
<a id="chd_death_definite_1"></a>
## atherosclerosis_events_incident: **chd_death_definite_1** (chd_death_definite)
An indicator of whether the cause of death was determined by medical professionals or technicians to be "definite" coronary heart disease for subjects who died during the follow-up period.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [FHS](#chd_death_definite_1-fhs)
* [WHI](#chd_death_definite_1-whi)
* **Metadata**:
Expand Down Expand Up @@ -499,7 +499,7 @@
<a id="chd_death_probable_1"></a>
## atherosclerosis_events_incident: **chd_death_probable_1** (chd_death_probable)
An indicator of whether the cause of death was determined by medical professionals or technicians to be "probable" or "definite" coronary heart disease for subjects who died during the follow-up period.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [FHS](#chd_death_probable_1-fhs)
* [WHI](#chd_death_probable_1-whi)
* **Metadata**:
Expand Down Expand Up @@ -654,7 +654,7 @@
<a id="coronary_angioplasty_incident_1"></a>
## atherosclerosis_events_incident: **coronary_angioplasty_incident_1** (coronary_angioplasty_incident)
An indicator of whether a subject had a coronary angioplasty procedure (that was verified by adjudication or by medical professionals) during the follow-up period.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [WHI](#coronary_angioplasty_incident_1-whi)
* **Metadata**:
**`Data Type`**: encoded, **`Measurement Units`**: None, **`Version`**: 1, **`Has Age Variable`**: Yes, **`Date Harmonized`**: 2019-10-31 16:34:10
Expand Down Expand Up @@ -698,7 +698,7 @@
<a id="mi_incident_1"></a>
## atherosclerosis_events_incident: **mi_incident_1** (mi_incident)
An indicator of whether a subject had a myocardial infarction (MI) event (that was verified by adjudication or by medical professionals) during the follow-up period.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [FHS](#mi_incident_1-fhs)
* [WHI](#mi_incident_1-whi)
* **Metadata**:
Expand Down Expand Up @@ -841,7 +841,7 @@
<a id="pad_incident_1"></a>
## atherosclerosis_events_incident: **pad_incident_1** (pad_incident)
An indicator of whether a subject had peripheral arterial disease (that was verified by adjudication or by medical professionals) during the follow-up period.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [FHS](#pad_incident_1-fhs)
* [WHI](#pad_incident_1-whi)
* **Metadata**:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<a id="angina_prior_1"></a>
## atherosclerosis_events_prior: **angina_prior_1** (angina_prior)
An indicator of whether a subject had an angina event prior to the baseline visit.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [CHS](#angina_prior_1-chs)
* [COPDGene](#angina_prior_1-copdgene)
* [FHS](#angina_prior_1-fhs)
Expand Down Expand Up @@ -216,7 +216,7 @@
<a id="cabg_prior_1"></a>
## atherosclerosis_events_prior: **cabg_prior_1** (cabg_prior)
An indicator of whether a subject had a coronary artery bypass graft (CABG) procedure prior to the start of the baseline visit.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#cabg_prior_1-aric)
* [CHS](#cabg_prior_1-chs)
* [COPDGene](#cabg_prior_1-copdgene)
Expand Down Expand Up @@ -499,7 +499,7 @@
<a id="coronary_angioplasty_prior_1"></a>
## atherosclerosis_events_prior: **coronary_angioplasty_prior_1** (coronary_angioplasty_prior)
An indicator of whether a subject had a coronary angioplasty procedure prior to the start of the baseline visit.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#coronary_angioplasty_prior_1-aric)
* [CHS](#coronary_angioplasty_prior_1-chs)
* [COPDGene](#coronary_angioplasty_prior_1-copdgene)
Expand Down Expand Up @@ -688,7 +688,7 @@
<a id="coronary_revascularization_prior_1"></a>
## atherosclerosis_events_prior: **coronary_revascularization_prior_1** (coronary_revascularization_prior)
An indicator of whether a subject had a coronary revascularization procedure prior to the start of the baseline visit. This includes angioplasty, CABG, and other coronary revascularization procedures.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* **Metadata**:
**`Data Type`**: encoded, **`Measurement Units`**: coronary_revascularization_prior, **`Version`**: 1, **`Has Age Variable`**: Yes, **`Date Harmonized`**: 2019-10-31 16:32:57
* **Controlled Vocabulary**:
Expand All @@ -709,7 +709,7 @@
<a id="mi_prior_1"></a>
## atherosclerosis_events_prior: **mi_prior_1** (mi_prior)
An indicator of whether a subject had a myocardial infarction (MI) prior to the start of the baseline visit.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#mi_prior_1-aric)
* [CHS](#mi_prior_1-chs)
* [COPDGene](#mi_prior_1-copdgene)
Expand Down Expand Up @@ -970,7 +970,7 @@
<a id="pad_prior_1"></a>
## atherosclerosis_events_prior: **pad_prior_1** (pad_prior)
An indicator of whether a subject had peripheral arterial disease prior to the baseline visit.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#pad_prior_1-aric)
* [CHS](#pad_prior_1-chs)
* [COPDGene](#pad_prior_1-copdgene)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<a id="bmi_baseline_1"></a>
## baseline_common_covariates: **bmi_baseline_1** (bmi_baseline)
Body mass index calculated at baseline.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* **Metadata**:
**`Data Type`**: decimal, **`Measurement Units`**: kg/m^2, **`Version`**: 4, **`Has Age Variable`**: Yes, **`Date Harmonized`**: 2019-09-30 16:03:59
* **Controlled Vocabulary**:
Expand Down Expand Up @@ -82,7 +82,7 @@
<a id="current_smoker_baseline_1"></a>
## baseline_common_covariates: **current_smoker_baseline_1** (current_smoker_baseline)
Indicates whether subject currently smokes cigarettes.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#current_smoker_baseline_1-aric)
* [CARDIA](#current_smoker_baseline_1-cardia)
* [CHS](#current_smoker_baseline_1-chs)
Expand Down Expand Up @@ -408,7 +408,7 @@
<a id="ever_smoker_baseline_1"></a>
## baseline_common_covariates: **ever_smoker_baseline_1** (ever_smoker_baseline)
Indicates whether subject ever regularly smoked cigarettes.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#ever_smoker_baseline_1-aric)
* [CARDIA](#ever_smoker_baseline_1-cardia)
* [CHS](#ever_smoker_baseline_1-chs)
Expand Down Expand Up @@ -786,7 +786,7 @@
<a id="height_baseline_1"></a>
## baseline_common_covariates: **height_baseline_1** (height_baseline)
Body height at baseline.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#height_baseline_1-aric)
* [CARDIA](#height_baseline_1-cardia)
* [CHS](#height_baseline_1-chs)
Expand Down Expand Up @@ -1052,7 +1052,7 @@
<a id="weight_baseline_1"></a>
## baseline_common_covariates: **weight_baseline_1** (weight_baseline)
Body weight at baseline.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#weight_baseline_1-aric)
* [CARDIA](#weight_baseline_1-cardia)
* [CHS](#weight_baseline_1-chs)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<a id="basophil_ncnc_bld_1"></a>
## blood_cell_count: **basophil_ncnc_bld_1** (basophil_ncnc_bld)
Count by volume, or number concentration (ncnc), of basophils in the blood (bld).
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#basophil_ncnc_bld_1-aric)
* [CARDIA](#basophil_ncnc_bld_1-cardia)
* [HCHS_SOL](#basophil_ncnc_bld_1-hchs_sol)
Expand Down Expand Up @@ -259,7 +259,7 @@
<a id="eosinophil_ncnc_bld_1"></a>
## blood_cell_count: **eosinophil_ncnc_bld_1** (eosinophil_ncnc_bld)
Count by volume, or number concentration (ncnc), of eosinophils in the blood (bld).
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#eosinophil_ncnc_bld_1-aric)
* [CARDIA](#eosinophil_ncnc_bld_1-cardia)
* [HCHS_SOL](#eosinophil_ncnc_bld_1-hchs_sol)
Expand Down Expand Up @@ -497,7 +497,7 @@
<a id="hematocrit_vfr_bld_1"></a>
## blood_cell_count: **hematocrit_vfr_bld_1** (hematocrit_vfr_bld)
Measurement of hematocrit, the fraction of volume (vfr) of blood (bld) that is composed of red blood cells.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#hematocrit_vfr_bld_1-aric)
* [CARDIA](#hematocrit_vfr_bld_1-cardia)
* [CHS](#hematocrit_vfr_bld_1-chs)
Expand Down Expand Up @@ -781,7 +781,7 @@
<a id="hemoglobin_mcnc_bld_1"></a>
## blood_cell_count: **hemoglobin_mcnc_bld_1** (hemoglobin_mcnc_bld)
Measurement of mass per volume, or mass concentration (mcnc), of hemoglobin in the blood (bld).
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#hemoglobin_mcnc_bld_1-aric)
* [CARDIA](#hemoglobin_mcnc_bld_1-cardia)
* [CHS](#hemoglobin_mcnc_bld_1-chs)
Expand Down Expand Up @@ -1063,7 +1063,7 @@
<a id="lymphocyte_ncnc_bld_1"></a>
## blood_cell_count: **lymphocyte_ncnc_bld_1** (lymphocyte_ncnc_bld)
Count by volume, or number concentration (ncnc), of lymphocytes in the blood (bld).
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#lymphocyte_ncnc_bld_1-aric)
* [CARDIA](#lymphocyte_ncnc_bld_1-cardia)
* [HCHS_SOL](#lymphocyte_ncnc_bld_1-hchs_sol)
Expand Down Expand Up @@ -1312,7 +1312,7 @@
<a id="mch_entmass_rbc_1"></a>
## blood_cell_count: **mch_entmass_rbc_1** (mch_entmass_rbc)
Measurement of the average mass (entmass) of hemoglobin per red blood cell(rbc), known as mean corpuscular hemoglobin (MCH).
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#mch_entmass_rbc_1-aric)
* [CARDIA](#mch_entmass_rbc_1-cardia)
* [HCHS_SOL](#mch_entmass_rbc_1-hchs_sol)
Expand Down Expand Up @@ -1541,7 +1541,7 @@
<a id="mchc_mcnc_rbc_1"></a>
## blood_cell_count: **mchc_mcnc_rbc_1** (mchc_mcnc_rbc)
Measurement of the mass concentration (mcnc) of hemoglobin in a given volume of packed red blood cells (rbc), known as mean corpuscular hemoglobin concentration (MCHC).
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#mchc_mcnc_rbc_1-aric)
* [CARDIA](#mchc_mcnc_rbc_1-cardia)
* [CHS](#mchc_mcnc_rbc_1-chs)
Expand Down Expand Up @@ -1829,7 +1829,7 @@
<a id="mcv_entvol_rbc_1"></a>
## blood_cell_count: **mcv_entvol_rbc_1** (mcv_entvol_rbc)
Measurement of the average volume (entvol) of red blood cells (rbc), known as mean corpuscular volume (MCV).
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#mcv_entvol_rbc_1-aric)
* [CARDIA](#mcv_entvol_rbc_1-cardia)
* [HCHS_SOL](#mcv_entvol_rbc_1-hchs_sol)
Expand Down Expand Up @@ -2067,7 +2067,7 @@
<a id="monocyte_ncnc_bld_1"></a>
## blood_cell_count: **monocyte_ncnc_bld_1** (monocyte_ncnc_bld)
Count by volume, or number concentration (ncnc), of monocytes in the blood (bld).
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#monocyte_ncnc_bld_1-aric)
* [CARDIA](#monocyte_ncnc_bld_1-cardia)
* [HCHS_SOL](#monocyte_ncnc_bld_1-hchs_sol)
Expand Down Expand Up @@ -2315,7 +2315,7 @@
<a id="neutrophil_ncnc_bld_1"></a>
## blood_cell_count: **neutrophil_ncnc_bld_1** (neutrophil_ncnc_bld)
Count by volume, or number concentration (ncnc), of neutrophils in the blood (bld).
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#neutrophil_ncnc_bld_1-aric)
* [CARDIA](#neutrophil_ncnc_bld_1-cardia)
* [HCHS_SOL](#neutrophil_ncnc_bld_1-hchs_sol)
Expand Down Expand Up @@ -2591,7 +2591,7 @@
<a id="platelet_ncnc_bld_1"></a>
## blood_cell_count: **platelet_ncnc_bld_1** (platelet_ncnc_bld)
Count by volume, or number concentration (ncnc), of platelets in the blood (bld).
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#platelet_ncnc_bld_1-aric)
* [CARDIA](#platelet_ncnc_bld_1-cardia)
* [CHS](#platelet_ncnc_bld_1-chs)
Expand Down Expand Up @@ -2872,7 +2872,7 @@
<a id="pmv_entvol_bld_1"></a>
## blood_cell_count: **pmv_entvol_bld_1** (pmv_entvol_bld)
Measurement of the mean volume (entvol) of platelets in the blood (bld), known as mean platelet volume (MPV or PMV).
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#pmv_entvol_bld_1-aric)
* [JHS](#pmv_entvol_bld_1-jhs)
* **Metadata**:
Expand Down Expand Up @@ -2951,7 +2951,7 @@
<a id="rbc_ncnc_bld_1"></a>
## blood_cell_count: **rbc_ncnc_bld_1** (rbc_ncnc_bld)
Count by volume, or number concentration (ncnc), of red blood cells in the blood (bld).
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#rbc_ncnc_bld_1-aric)
* [CARDIA](#rbc_ncnc_bld_1-cardia)
* [HCHS_SOL](#rbc_ncnc_bld_1-hchs_sol)
Expand Down Expand Up @@ -3157,7 +3157,7 @@
<a id="rdw_ratio_rbc_1"></a>
## blood_cell_count: **rdw_ratio_rbc_1** (rdw_ratio_rbc)
Measurement of the ratio of variation in width to the mean width of the red blood cell (rbc) volume distribution curve taken at +/- 1 CV, known as red cell distribution width (RDW).
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#rdw_ratio_rbc_1-aric)
* [HCHS_SOL](#rdw_ratio_rbc_1-hchs_sol)
* [JHS](#rdw_ratio_rbc_1-jhs)
Expand Down Expand Up @@ -3304,7 +3304,7 @@
<a id="wbc_ncnc_bld_1"></a>
## blood_cell_count: **wbc_ncnc_bld_1** (wbc_ncnc_bld)
Count by volume, or number concentration (ncnc), of white blood cells in the blood (bld).
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#wbc_ncnc_bld_1-aric)
* [CARDIA](#wbc_ncnc_bld_1-cardia)
* [CHS](#wbc_ncnc_bld_1-chs)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<a id="antihypertensive_meds_1"></a>
## blood_pressure: **antihypertensive_meds_1** (antihypertensive_meds)
Indicator for use of antihypertensive medication at the time of blood pressure measurement.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#antihypertensive_meds_1-aric)
* [CARDIA](#antihypertensive_meds_1-cardia)
* [CHS](#antihypertensive_meds_1-chs)
Expand Down Expand Up @@ -374,7 +374,7 @@
<a id="bp_diastolic_1"></a>
## blood_pressure: **bp_diastolic_1** (bp_diastolic)
Resting diastolic blood pressure from the upper arm in a clinical setting.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#bp_diastolic_1-aric)
* [CARDIA](#bp_diastolic_1-cardia)
* [CHS](#bp_diastolic_1-chs)
Expand Down Expand Up @@ -822,7 +822,7 @@
<a id="bp_systolic_1"></a>
## blood_pressure: **bp_systolic_1** (bp_systolic)
Resting systolic blood pressure from the upper arm in a clinical setting.
* **Harmonization Units**:
* **Study (harmonization_units)**:
* [ARIC](#bp_systolic_1-aric)
* [CARDIA](#bp_systolic_1-cardia)
* [CHS](#bp_systolic_1-chs)
Expand Down
Loading

0 comments on commit 01c286f

Please sign in to comment.