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
Copy file name to clipboardexpand all lines: vignettes/mapmetadata.Rmd
+5-5
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ It is recommended to view the descriptions of each table to give you more contex
41
41
42
42
# Understanding mapping outputs
43
43
44
-
Running [metadata_map](https://docs.ropensci.org/mapmetadata/reference/metadata_map.html) will run this function in demo mode (as explained in the README) and generate six files in your project directory.
44
+
Running [metadata_map](https://docs.ropensci.org/mapmetadata/reference/metadata_map.html) will run this function in demo mode (as explained in the README) and generate six files in your project directory.
45
45
46
46
By default, the demo mode processes the first 5 variables in a table. Running `metadata_map(demo_number = 20)` will process the first 20 variables in a table.
47
47
Here you can [view outputs generated from this longer demo run](https://github.com/ropensci/mapmetadata/tree/main/inst/outputs/), which include:
@@ -53,15 +53,15 @@ Here you can [view outputs generated from this longer demo run](https://github.c
53
53
-**MAPPING_360_NCCHD_CHILD_timestamp.csv**
54
54
- The mappings between variables in the CHILD table and the research domains.
55
55
-**L-MAPPING_360_NCCHD_CHILD_timestamp.csv**
56
-
- The same mappings as the previous file, but saved in a longer format. See the argument `long_output = TRUE` in [metadata_map](https://docs.ropensci.org/mapmetadata/reference/metadata_map.html). If `long_output = FALSE` was used, the long outputs can be generated by directly calling the [map_convert](https://docs.ropensci.org/mapmetadata/reference/map_convert.html) function.
56
+
- The same mappings as the previous file, but saved in a longer format. See the argument `long_output = TRUE` in [metadata_map](https://docs.ropensci.org/mapmetadata/reference/metadata_map.html). If `long_output = FALSE` was used, the long outputs can be generated by directly calling the [map_convert](https://docs.ropensci.org/mapmetadata/reference/map_convert.html) function.
57
57
-**MAPPING_LOG_360_NCCHD_CHILD_timestamp.csv**
58
58
- A log file that accompanies the MAPPING file, describing features of the session and the table processed.
59
59
-**MAPPING_PLOT_360_NCCHD_CHILD_timestamp.png**
60
60
- A simple visual representation of the mappings, displaying the count of each domain code.
61
61
62
62
# Compare mapping
63
63
64
-
Running the function [map_compare](https://docs.ropensci.org/mapmetadata/reference/map_compare.html) will allow you to compare the mappings from two sessions, perhaps two different researchers. This function compares csv outputs from two sessions, finds their differences, and asks for a consensus, creating a new output file:
64
+
Running the function [map_compare](https://docs.ropensci.org/mapmetadata/reference/map_compare.html) will allow you to compare the mappings from two sessions, perhaps two different researchers. This function compares csv outputs from two sessions, finds their differences, and asks for a consensus, creating a new output file:
The default lookup table (printed above) governs the automatic categorisations within the [metadata_map](https://docs.ropensci.org/mapmetadata/reference/metadata_map.html) function:
150
+
The default lookup table (printed above) governs the automatic categorisations within the [metadata_map](https://docs.ropensci.org/mapmetadata/reference/metadata_map.html) function:
151
151
152
152
1. When a variable needs to be mapped to a domain, before asking the user it searches the lookup table
153
153
2. If the variable name is contained within the 'Variable' column of the lookup table, this triggers the auto-categorisation
@@ -157,7 +157,7 @@ When creating a custom lookup table, create your own csv and provide that as an
157
157
158
158
# Copying across tables
159
159
160
-
If you're processing multiple tables (i.e. in run one of [metadata_map](https://docs.ropensci.org/mapmetadata/reference/metadata_map.html) select table one, in run two select table two) save all outputs in the same directory to enable table copying. This feature will speed up categorisation and ensure consistency.
160
+
If you're processing multiple tables (i.e. in run one of [metadata_map](https://docs.ropensci.org/mapmetadata/reference/metadata_map.html) select table one, in run two select table two) save all outputs in the same directory to enable table copying. This feature will speed up categorisation and ensure consistency.
161
161
If it finds other MAPPING files with the same ID_Name in the output directory, and they contain overlapping variables, it will automatically copy the mappings from this previous table to the current table.
0 commit comments