You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://www.repostatus.org/#active)
7
8
[](https://github.com/ropensci/software-review/issues/674)
For researchers working with health datasets, there are many great resources that summarise features about these datasets (often termed metadata) and how to access them. Access to metadata can help researchers plan projects prior to gaining full access to health datasets. Learn more about health metadata in our [Health Metadata article hosted on the package website](https://aim-rsf.github.io/mapmetadata/articles/HealthMetadata.html).
16
+
For researchers working with health datasets, there are many great resources that summarise features about these datasets (often termed metadata) and how to access them. Access to metadata can help researchers plan projects prior to gaining full access to health datasets. Learn more about health metadata in our [Health Metadata article hosted on the package website](https://docs.ropensci.org/mapmetadata/articles/HealthMetadata.html).
16
17
17
18
One comprehensive open resource is the [Health Data Research Gateway](https://healthdatagateway.org/search?search=&datasetSort=latest&tab=Datasets), managed by [Health Data Research UK](https://www.hdruk.ac.uk/) in collaboration with the [UK Health Data Research Alliance](https://ukhealthdata.org/). The gateway can help a researcher address questions such as: *What datasets are available? What are the features of these datasets? Which datasets fit my research? How do I access these datasets? How have these datasets been used by the community before, and do they link to others? What publications, or other resources exist, using these datasets?*
18
19
@@ -24,11 +25,10 @@ Secondly, it helps the researcher address the question *Which variables map onto
There are three main functions you can interact with: `metadata_map`, `map_compare`, and `map_convert`. For more information on any function, type `?function_name`.
43
43
44
-
The main function is `metadata_map` and you can run it in demo mode using the files located in the [inst/inputs](https://github.com/aim-rsf/mapmetadata/tree/main/inst/inputs) directory:
44
+
The main function is `metadata_map` and you can run it in demo mode using the files located in the [inst/inputs](https://github.com/ropensci/mapmetadata/tree/main/inst/inputs) directory:
45
45
46
46
```r
47
47
metadata_map()
@@ -63,7 +63,7 @@ Enter the table number you want to process:
63
63
64
64
You can exit here (with Clt-C or Esc) to just get this summary plot, which is saved to your project directory. All outputs from this `metadata_map` function are saved to your project directory. You can change the save location by adjusting the `output_dir` argument (an argument means the information given to a function, to alter how it runs). For example `metadata_map(output_dir = 'username/sub_directory')`.
65
65
66
-
<imgsrc="https://raw.githubusercontent.com/aim-rsf/mapmetadata/main/inst/outputs/BAR_360_NCCHD_2025-02-14-18-14-01.png"alt="example bar plot showing number of variables for each table alongside counts of whether variables have missing descriptions">
66
+
<imgsrc="https://raw.githubusercontent.com/ropensci/mapmetadata/main/inst/outputs/BAR_360_NCCHD_2025-02-14-18-14-01.png"alt="example bar plot showing number of variables for each table alongside counts of whether variables have missing descriptions">
67
67
68
68
If you continue to the mapping stage, you will see all the tables in this dataset are listed. Select the 4th table for demo purposes:
69
69
@@ -86,7 +86,7 @@ Add a note for processing this table:
86
86
87
87
Optional note about this table: Demo run
88
88
```
89
-
This table has 35 variables (see 'n of 35' below) but the demo run will only process the first 5 variables (by default). If it skips over a variable (as is the case with 1, 2 and 3) this means it has been auto-categorised. Variable 4 has not been auto-categorised and is asking you to categorise it. You will be asked to categorise a variable with one (or more) of the numbers shown in the [key that has appeared in your plots tab](https://github.com/aim-rsf/mapmetadata/tree/main/inst/outputs/plots_tab_demo_domains.png). We input '8' which means 'Health Info' as defined by the key. The demo simplifies domains for demonstration purposes; for a research study, your domains are likely to be much more specific e.g. ‘Prenatal, antenatal, neonatal and birth’ or ‘Health behaviours and diet’.
89
+
This table has 35 variables (see 'n of 35' below) but the demo run will only process the first 5 variables (by default). If it skips over a variable (as is the case with 1, 2 and 3) this means it has been auto-categorised. Variable 4 has not been auto-categorised and is asking you to categorise it. You will be asked to categorise a variable with one (or more) of the numbers shown in the [key that has appeared in your plots tab](https://github.com/ropensci/mapmetadata/tree/main/inst/outputs/plots_tab_demo_domains.png). We input '8' which means 'Health Info' as defined by the key. The demo simplifies domains for demonstration purposes; for a research study, your domains are likely to be much more specific e.g. ‘Prenatal, antenatal, neonatal and birth’ or ‘Health behaviours and diet’.
90
90
91
91
```
92
92
ℹ Table variable 1 of 35 (5 left to process)
@@ -112,13 +112,20 @@ Repeat the categorisation for the 5th variable to finish. You will then be asked
112
112
113
113
- Second, you will be asked if you want to review your own categorisations. Select Yes(1) and follow the instructions.
114
114
115
-
You can use the output file from the `metadata_map()` function as input for subsequent analysis to filter and visualise variables by research domain. For more information on custom inputs (metadata file, domain list and lookup) and how to understand the outputs, see the [mapmetadata tutorial](https://aim-rsf.github.io/mapmetadata/articles/mapmetadata.html) page on the package website.
115
+
You can use the output file from the `metadata_map()` function as input for subsequent analysis to filter and visualise variables by research domain. For more information on custom inputs (metadata file, domain list and lookup) and how to understand the outputs, see the [mapmetadata tutorial](https://ropensci.github.io/mapmetadata/articles/mapmetadata.html) page on the package website.
116
116
117
117
## License
118
118
119
-
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](https://github.com/aim-rsf/mapmetadata/blob/main/LICENSE.md) file for details.
119
+
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](https://github.com/ropensci/mapmetadata/blob/main/LICENSE.md) file for details.
120
120
For more information, refer to [GNU General Public License](https://www.gnu.org/licenses/gpl-3.0.en.html).
121
121
122
+
## Code of Conduct
123
+
124
+
Please note that this package is released with a [Contributor
125
+
Code of Conduct](https://ropensci.org/code-of-conduct/).
126
+
By
127
+
contributing to this project, you agree to abide by its terms.
128
+
122
129
## Citation
123
130
124
131
To cite `mapmetadata` in publications:
@@ -139,10 +146,10 @@ A BibTeX entry for LaTeX users:
139
146
140
147
## Contributing
141
148
142
-
We welcome contributions to `mapmetadata`. Please read our [Contribution Guidelines](https://github.com/aim-rsf/mapmetadata/blob/main/CONTRIBUTING.md) for details on how to contribute.
149
+
We welcome contributions to `mapmetadata`. Please read our [Contribution Guidelines](https://github.com/ropensci/mapmetadata/blob/main/CONTRIBUTING.md) for details on how to contribute.
143
150
144
-
-**Report Issues**: Found a bug? Have a feature request? Report it on [GitHub Issues](https://github.com/aim-rsf/mapmetadata/issues).
145
-
-**Submit Pull Requests**: Follow our [Contribution Guidelines](https://github.com/aim-rsf/mapmetadata/blob/main/CONTRIBUTING.md) for pull requests.
151
+
-**Report Issues**: Found a bug? Have a feature request? Report it on [GitHub Issues](https://github.com/ropensci/mapmetadata/issues).
152
+
-**Submit Pull Requests**: Follow our [Contribution Guidelines](https://github.com/ropensci/mapmetadata/blob/main/CONTRIBUTING.md) for pull requests.
146
153
-**Feedback**: Share your thoughts by opening an issue.
147
154
148
155
### Contributors ✨
@@ -155,12 +162,12 @@ Thanks go to these wonderful people ([emoji key](https://allcontributors.org/doc
0 commit comments