Using Txt Files

The mapping process can be less manual by using .txt files.The format specifications are given at the end of the page, along with examples. Currently the .txt files, mapper.txt and mapping.txt are available to view in Archivist, as detailed below.

Note: you must be logged into Archivist to view the below pages.

A question list can be saved as a .txt from Archivist by navigating to the instrument view and then adding /mapper.txt to the web address e.g.https://archivist.closer.ac.uk/instruments/alspac_01_rat/mapper.txt.

The question to variable mapping.txt (once applied) can be viewed in Archivist by navigating to the instrument view and then adding /mapping.txt to the web address e.g.https://archivist.closer.ac.uk/instruments/alspac_01_rat/mapping.txt

The following steps can be used to upload mappings via the .txt files.

1)      Import the sledgehammer XML

Check whether the dataset has been uploaded by searching the main Datasets page, if not, upload the XML file. Admin > Import. Under Upload DDI Dataset files, browse and Import Dataset. This might take a while to appear in the Datasets list.

Note: The prefix used when running Sledgehammer must be identical to the instrument prefix. This must be checked carefully as otherwise this will mean mappings will have to be redone.

Note: DDI-Flavour must be run after Sledgehammer has been run, and before importing.

Note: This step is currently run by the CLOSER team, as the dataset needs to be linked with the instrument, which is a feature yet to be added to Archivist.

2)      Import the variable mappings

Admin > Datasets > search for the loaded dataset (prefix or dataset name) > Import Mappings. Both the tvlinking.txt and the dv.txt can be imported. If uploading new mapping files, these will not replace those already mapped, but will add any additional mappings.

3)      Import the question mappings

Admin > Instruments > search for the questionnaire prefix > Import Mappings. Both the qvmapping.txt and tqlinking.txt can be imported. If uploading new mapping files, these will not replace those already mapped, but will add any additional mappings.

4)     Check the mappings in both the dataset and instrument view.

 Datasets > search and select the Name of the dataset.  Any mapping conflicts will appear in red.

The question-variable mappings can also be checked through Instruments > search and select the Prefix (or view) of the instrument. This will gives the questionnaire view with the variable names listed against them

Note: Variables can be mapped to grid references in the mapping.txt file, but currently these will only be displayed as mapped to the gird as a whole.

Format specifications:

mapper.txt

Question and sequence list produced by Archivist.

• ID (qc or URN)
• Type (“Question” or “Sequence”)
• Grid limits or “-“ for null ([Y,X])
• Parent (URN)
• Text (Literal or Sequence name)

mapping.txt

Mapping file which links questions and variables (listing all variables and derived variables).

• Tab delimited
• Must include all variables including derived variables
• 2 columns:
  • qc
    • Question name
    • ‘0’ if mapped to nothing
    • ‘0’ if derived variable
    • [OPTIONAL] suffix grid cell coordinates in the format $X;Y. Please refer to the Grid coordinates table on the condition page for how to reference grid cells.
  • Variable name

tvlinking.txt

Mapping file which links topics and variables.

• Tab delimited
• Used for applying level 1 and 2 topics to variables
• Uses Colectica topic IDs
• 2 columns:
  • Variable name
  • Topic ID

 tqlinking.txt

Mapping file which links topics and questions.

• Tab delimited
• Used for applying level 1 and 2 topics to variables
• Uses Colectica topic IDs
• 2 columns:
  • qc (question identifier)
  • Topic ID

dv.txt

Mapping file which links derived variables to variables.

• Tab delimited
• 2 columns:
  • Derived variable name
  • Source variable name

Note: All the .txt mapping files detailed above will be available to view in Archivist v.10 (the current version can be found under Info).