Skip to content

Commit

Permalink
Merge pull request #32 from uc-cdis/add-cde
Browse files Browse the repository at this point in the history
Update language for VLMD section
  • Loading branch information
smvgarcia authored Sep 17, 2024
2 parents aed6e9d + 70ff400 commit 28d55f7
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 16 deletions.
10 changes: 5 additions & 5 deletions docs/vlmd/index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Variable-level Metadata Submission

The HEAL Data Platform includes two sources of variable-level metadata (VLMD):
The HEAL Data Platform contains variable-level metadata (VLMD) from two sources:

* [**Data Dictionaries:**](#data-dictionaries) these describe each variable within a study's dataset
* [**HEAL CDEs (Common Data Elements):**](#heal-cdes-common-data-elements) these are validated and structured questionnaires used by HEAL investigators conducting research with human participants to harmonize the data collected by different studies
* [**Data Dictionaries:**](#data-dictionaries) these files describe each variable within a study's dataset
* [**HEAL CDEs (Common Data Elements):**](#heal-cdes-common-data-elements) these are validated and structured questionnaires used by investigators conducting research with human participants to harmonize the data collected across studies

!!! info

In order to submit any VLMD to the Platform, two conditions must be true:
**1) The study must already be registered:** If your study is not yet registered, please see our instructions for how to register your study before submitting VLMD.
**1) The study must already be registered:** If your study is not yet registered on the HEAL Data Platform, please see our instructions for how to register your study before submitting VLMD.
<p align="center">[How to Register Your Study](../study-registration/index.md){ .md-button }</p>

Expand All @@ -31,4 +31,4 @@ In order to submit a study’s data dictionary to the Platform, the data diction

HEAL CDEs are validated and structured questionnaires that include fields describing the human subject data collected, along with how the data was gathered, and how the response is represented in the dataset. HEAL investigators conducting research with human participants use CDEs to allow the data collected by different studies to be harmonized for further analyses. [*(To learn more about HEAL CDEs, visit this NIH page.)*](https://heal.nih.gov/data/common-data-elements)

To report the CDEs your study used to the Platform, follow the instructions on [this page](vlmd_submit_CDE.md).
* To report the CDEs your study used to the Platform, follow the instructions on [this page](vlmd_submit_CDE.md).
8 changes: 5 additions & 3 deletions docs/vlmd/vlmd_request_access.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
# Request Access to Submit VLMD
# Request Access to Submit Variable-level Metadata (VLMD)

!!! info

In order to submit a Data Dictionary to the Platform, **the study must already be registered.** If your study is not yet registered, please see our instructions for how to register your study before submitting VLMD.
In order to submit a Data Dictionary to the Platform, **the study must already be registered on the HEAL Data Platform.** If your study is not yet registered, please see our instructions for how to register your study before submitting VLMD.

<p align="center">[How to Register Your Study](../study-registration/index.md){ .md-button }</p>

---

## Request Access to Submit Variable-level Metadata

Requesting Access is the first step in submitting VLMD to the HEAL Data Platform. If you were the person that registered the study on the Platform, you can go directly to [Submit VLMD](#submit-vlmd). If someone else registered the study, follow the steps below to request access to submit VLMD.

### Login to the HEAL Data Platform

Click on the [Login button in the upper right corner](https://healdata.org/portal/login) to log in to the Platform.
Expand All @@ -32,7 +34,7 @@ From the [Discovery Page](https://healdata.org/portal/discovery), find the study
If you see:

- **`Login to...`** - you are not logged in. [Log in first](https://healdata.org/portal/login), then repeat the instructions above.
- **`Request Access to Register This Study`** - your study is not yet registered. Follow these instructions to [request access and register your study](../study-registration/index.md).
- **`Request Access to Register This Study`** - your study is not yet registered on the HEAL Data Platform. Follow these instructions to [request access and register your study](../study-registration/index.md).
- **`Submit Variable-level Metadata`** - You already have access to submit VLMD. Proceed to [submit your data dictionary or CDEs](#submit-vlmd).

### Complete the VLMD Submission Request Form
Expand Down
8 changes: 4 additions & 4 deletions docs/vlmd/vlmd_submission.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

In order to submit a Data Dictionary to the Platform, the following conditions must be true:
**1) The study must already be registered:** If your study is not yet registered, please see our instructions for how to register your study before submitting VLMD.
**1) The study must already be registered:** If your study is not yet registered on the HEAL Data Platform, please see our instructions for how to register your study before submitting VLMD.
<p align="center">[How to Register Your Study](../study-registration/index.md){ .md-button }</p>

Expand Down Expand Up @@ -43,7 +43,7 @@ From the [Discovery Page](https://healdata.org/portal/discovery), find the study

- **`Login to...`** - you are not logged in. [Log in first](https://healdata.org/portal/login), then repeat the instructions above.
- **`Request Access to Submit Variable-level Metadata`** - you have not yet gotten access to submit VLMD. Follow these instructions to [request access to submit VLMD](vlmd_request_access.md).
- **`Request Access to Register This Study`** - your study is not yet registered. Follow these instructions to [request access and register your study](../study-registration/index.md).
- **`Request Access to Register This Study`** - your study is not yet registered on the HEAL Data Platform. Follow these instructions to [request access and register your study](../study-registration/index.md).

## Submit Your Data Dictionary

Expand All @@ -56,8 +56,8 @@ The VLMD submission form defaults to the Data Dictionary tab (see box at top).
- Only TSV, CSV and JSON files can be submitted
- While multiple dictionaries can be associated with a study, the process currently supports one submission at a time. Please repeat this process for each data dictionary you wish to submit
- *Submissions should not include data of any kind. Submissions containing data will be removed from the Platform.*
- Enter a unique name for your data dictionary. This name will be used to identify the data dictionary for users on the Platform.
- Previously submitted data dictionary names are displayed, if applicable - using the same name for a new submission will overwrite the existing record.
- Enter a name for your data dictionary. This name will be visible to users on the Platform.
- Previously-submitted data dictionary names are displayed, if applicable; using the same name for a new submission will overwrite the existing record.
- To facilitate processing of your submission, some administrative information is needed to allow HEAL Data Platform staff to contact you should the need arise:
- First and Last name
- E-mail address
Expand Down
6 changes: 3 additions & 3 deletions docs/vlmd/vlmd_submit_CDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

In order to report your CDEs to the Platform, the following conditions must be true:
**1) The study must already be registered:** If your study is not yet registered, please see our instructions for how to register your study before submitting VLMD.
**1) The study must already be registered:** If your study is not yet registered on the HEAL Data Platform, please see our instructions for how to register your study before submitting VLMD.
<p align="center">[How to Register Your Study](../study-registration/index.md){ .md-button }</p>

Expand Down Expand Up @@ -35,7 +35,7 @@ From the [Discovery Page](https://healdata.org/portal/discovery), find the study

- **`Login to...`** - you are not logged in. [Log in first](https://healdata.org/portal/login), then repeat the instructions above.
- **`Request Access to Submit Variable-level Metadata`** - you have not yet gotten access to submit VLMD. Follow these instructions to [request access to submit VLMD](vlmd_request_access.md).
- **`Request Access to Register This Study`** - your study is not yet registered. Follow these instructions to [request access and register your study](../study-registration/index.md).
- **`Request Access to Register This Study`** - your study is not yet registered on the HEAL Data Platform. Follow these instructions to [request access and register your study](../study-registration/index.md).

## Report CDEs

Expand All @@ -49,7 +49,7 @@ Below the `Study` field is a checklist of core CDEs. Check the box for any you w
![](../img/vlmd_cde_submission_form_middle.png)

To add other CDEs not in the core list, you can click in the box beneath the core list and begin typing CDE codes or names to filter other CDEs that include the typed string (see the yellow highlighting). Click the CDE in the filtered list to add.
To add Supplemental CDEs not in the core list, you can click in the box beneath the core list and begin typing CDE names or codes to filter other CDEs that include the typed string (see the yellow highlighting). Click the CDE in the filtered list to add.

![](../img/vlmd_cde_submission_form_not-core.png)

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ nav:
- cedar-getting-started.md
- Variable-level Metadata Submission:
- vlmd/index.md
- vlmd/vlmd_request_access.md
- Request Access to Submit VLMD: vlmd/vlmd_request_access.md
- vlmd/vlmd_healdata_utils.md
- vlmd/vlmd_submission.md
- vlmd/vlmd_submit_CDE.md
Expand Down

0 comments on commit 28d55f7

Please sign in to comment.