Skip to content

Commit

Permalink
re-order info
Browse files Browse the repository at this point in the history
  • Loading branch information
RayStick authored Dec 20, 2024
1 parent 6b123c9 commit 5bead7f
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions vignettes/mapmetadata.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,14 @@ For installation, set-up and basic usage refer to the package [README.md](https:

<img src="https://raw.githubusercontent.com/aim-rsf/mapmetadata/main/inst/outputs/BAR_360_NationalCommunityChildHealthDatabase(NCCHD)_2024-12-19-18-07-22.png" alt="example bar plot showing number of variables for each table alongside counts of whether variables have missing descriptions"/>

This bar plot is produced automatically when you run the `metadata_map` function. The bar plot can help you understand the scope of the dataset, but reference the HDRUK Gateway page for the fuller context. For instance, table descriptions are not included in these structural metadata files but they are included on the gateway:
This bar plot is produced automatically when you run the `metadata_map` function. The bar plot shows us there are 13 tables in the dataset. The height of the bar indicates the number of variables in that table:

- The ones with lots of variables (e.g. CHILD_TRUST) will take you longer to process
- Some tables (e.g. CHE_HEALTHYCHILDWALESPROGRAMME) have a lot of empty descriptions. An empty description means that this variable will only have a label and a data type.

It is important to note that this plot is only summarising *variable* level metadata i.e. a description of what the variable is. Some variables also require *value* level metadata i.e. what does each value correspond to, 1 = Yes, 2 = No, 3 = Unknown. This *value* level metadata can sometimes be found in lookup tables, if it is not provided within the *variable* level description.

The bar plot can help you understand the scope of the dataset, but reference the HDRUK Gateway page for the fuller context. For instance, table descriptions are not included in these structural metadata files but they are included on the gateway:

**For dataset NCCHD, used in the demo, the structural metadata was downloaded here:**

Expand All @@ -30,13 +37,6 @@ This bar plot is produced automatically when you run the `metadata_map` function

<img src="https://raw.githubusercontent.com/aim-rsf/mapmetadata/main/inst/outputs/NCCHD_gateway_table.png" alt="screenshot of HRDRUK gateway showing table descriptions"/>

The bar plot shows us there are 13 tables in the dataset. The height of the bar indicates the number of variables in that table:

- The ones with lots of variables (e.g. CHILD_TRUST) will take you longer to process
- Some tables (e.g. CHE_HEALTHYCHILDWALESPROGRAMME) have a lot of empty descriptions. An empty description means that this variable will only have a label and a data type.

It is important to note that this plot is only summarising *variable* level metadata i.e. a description of what the variable is. Some variables also require *value* level metadata i.e. what does each value correspond to, 1 = Yes, 2 = No, 3 = Unknown. This *value* level metadata can sometimes be found in lookup tables, if it is not provided within the *variable* level description.

# Mapping

Use the bar plot and the HDRUK Gateway to guide your mapping choices. The main functionality of this package is to aid a researcher in mapping variables from health datasets onto their research domains (concepts/latent variables).
Expand Down

0 comments on commit 5bead7f

Please sign in to comment.