From 1cf417ad4eae808215b764613ee35635e8736dab Mon Sep 17 00:00:00 2001 From: smvgarcia Date: Tue, 17 Sep 2024 10:35:01 -0500 Subject: [PATCH 1/2] Update language for VLMD section --- docs/vlmd/index.md | 8 ++++---- docs/vlmd/vlmd_request_access.md | 6 ++++-- docs/vlmd/vlmd_submission.md | 8 ++++---- docs/vlmd/vlmd_submit_CDE.md | 6 +++--- 4 files changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/vlmd/index.md b/docs/vlmd/index.md index 3b61525..2f7f173 100644 --- a/docs/vlmd/index.md +++ b/docs/vlmd/index.md @@ -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.

[How to Register Your Study](../study-registration/index.md){ .md-button }

diff --git a/docs/vlmd/vlmd_request_access.md b/docs/vlmd/vlmd_request_access.md index 6260d32..7497fbe 100644 --- a/docs/vlmd/vlmd_request_access.md +++ b/docs/vlmd/vlmd_request_access.md @@ -2,7 +2,7 @@ !!! 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.

[How to Register Your Study](../study-registration/index.md){ .md-button }

@@ -10,6 +10,8 @@ ## 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. @@ -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 diff --git a/docs/vlmd/vlmd_submission.md b/docs/vlmd/vlmd_submission.md index e59ab76..be35a84 100644 --- a/docs/vlmd/vlmd_submission.md +++ b/docs/vlmd/vlmd_submission.md @@ -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.

[How to Register Your Study](../study-registration/index.md){ .md-button }

@@ -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 @@ -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 diff --git a/docs/vlmd/vlmd_submit_CDE.md b/docs/vlmd/vlmd_submit_CDE.md index c96aab2..aa503f8 100644 --- a/docs/vlmd/vlmd_submit_CDE.md +++ b/docs/vlmd/vlmd_submit_CDE.md @@ -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.

[How to Register Your Study](../study-registration/index.md){ .md-button }

@@ -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 @@ -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) From 70ff40044d2bad0c47dfd92f5b9329b734461c22 Mon Sep 17 00:00:00 2001 From: smvgarcia Date: Tue, 17 Sep 2024 11:11:39 -0500 Subject: [PATCH 2/2] missed some updates --- docs/vlmd/index.md | 2 +- docs/vlmd/vlmd_request_access.md | 2 +- mkdocs.yaml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/vlmd/index.md b/docs/vlmd/index.md index 2f7f173..571809a 100644 --- a/docs/vlmd/index.md +++ b/docs/vlmd/index.md @@ -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). diff --git a/docs/vlmd/vlmd_request_access.md b/docs/vlmd/vlmd_request_access.md index 7497fbe..d6bd615 100644 --- a/docs/vlmd/vlmd_request_access.md +++ b/docs/vlmd/vlmd_request_access.md @@ -1,4 +1,4 @@ -# Request Access to Submit VLMD +# Request Access to Submit Variable-level Metadata (VLMD) !!! info diff --git a/mkdocs.yaml b/mkdocs.yaml index 1451f78..97aa393 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -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