Item Details#
Each item in the repository has a detail page at /item/{agency}/{identifier}.
To view a specific version, add the version number: /item/{agency}/{identifier}/{version}.
Tabs#
Below the title, a row of tabs organizes the information about the item.
- Content
The main content area shows all the metadata defined for the item. Depending on the item type, this information may be organized into multiple sections.
- Appears Within
Shows which other items reference the current item. Click one of the items to navigate to that item’s detail page.
- Information
Basic administrative information about the current item.
- History
A list of previous versions of the item.
- Download
Lets you download the item in various formats.
Information#
- Agency
The authoritative agency for the item
- Identifier
The unique identifier of the item
- Version
The version number of the item
- DDI URN
The full DDI URN of the item, in the form
urn:ddi:{agency}:{identifier}:{version}- Last Updated
The date and time the item was published
- Storage Format
The DDI version in which the item is stored
- Tags
Any tags applied to this version of the item
- Updated by
The person who published the item. This is only shown if enabled by the administrator.
- Rationale
The log message provided when the item was published. This is only shown if enabled by the administrator.
Any additional identifiers recorded for the item, such as DOIs, are listed below these rows.
History#
The History tab shows a list of previous versions of the item, with the date of each revision. Click a revision number to view the item as it was at that time, or click Compare next to a revision to see the differences between that version and the current one.
The View Full History button shows the complete version history, including the branching structure of the versions.
Note
Depending on the configuration of your portal, you may need to log in to view or compare previous versions.
Compare Versions#
The version comparison page shows the changes between two versions of an item. Changes are marked as added, removed, modified, or moved. Use the filter chips to show only one kind of change, type in the filter box to find a specific change, and use the swap button to reverse the comparison.
Download#
The Download tab lets you download the item in various formats.
A PDF document containing all the item’s content. If the portal is configured with several metadata languages, one PDF link is offered per language.
- DDI 3.3 Fragment
A standardized DDI 3.3 XML file containing only this item
- DDI 3.3 Set
A DDI 3.3 XML file containing this item and every item it references, directly or indirectly. This is only available for the item types configured by the administrator.
- DDI 3.2 Fragment
A standardized DDI 3.2 XML file, for item types that DDI 3.2 supports
- DDI 3.1
A standardized DDI 3.1 XML file, for item types that DDI 3.1 supports
- JSON
A JSON file with the item’s content. JSON is useful for programmatic access to the item’s information.
Note
Depending on the configuration of your portal, some downloads may require you to log in. See Site Information.
Users Also Viewed#
The Users Also Viewed area lists items most frequently viewed by other users of the site who have visited the current item’s page.
Rating and Comments#
If the administrator has enabled rating, logged in users can rate the item from one to five stars, and the average rating is displayed.
If the administrator has enabled commenting, logged in users can add comments to the item. Comments on the displayed version are shown first, followed by comments on other versions.
Compare Items#
Up to ten variables, or up to ten questions, can be compared side by side. Check the Compare box next to each item on the search page and click Compare Checked. The comparison page lists each property of the items in a table, one column per item.
Variables#
In addition to the variable’s description and representation, the variable page shows:
- Statistics
Summary statistics and frequency charts, when statistics have been registered for the variable.
- Source Questions and Measurements
The questions and measurements from which the variable’s data were collected.
- Lineage
A graph of the variable’s sources (the variables and questions from which it was derived) and its successors (the variables derived from it). The graph can be downloaded as SVG or PNG, and the relationships as a CSV edge list. A List view shows the same information as a table. The depth and size of the graph are limited by the
RepositorySettings:Portal:Lineagesettings described in appsettings.json.- Derivations and Calculations
Variables derived from this variable, and the instructions used to create them.
- Concordance
A View Concordance button that opens the concordance for the variable’s represented or conceptual variable.
Questionnaires#
The questionnaire (instrument) page presents the questionnaire in several tabs.
- Canvas
The questionnaire’s sections and questions as nested panels, with a structure tree for navigation. If commenting is enabled, comment threads can be added to the questionnaire and its questions, and resolved or reopened.
- Questions
A filterable table of every question, with its number, name, text, display logic, and location.
- Routing
A zoomable graph of the questionnaire’s routing, or a list of the conditions.
- Concepts
The concepts used by the questionnaire’s questions, grouped by concept system.
- Details
The questionnaire’s name, label, description, type, and any external instrument locations.
Questions#
The question page shows the question text, response options, and interviewer instructions. The Question in Context area shows the preceding and following questions, the question’s position within the questionnaire, and any inherited display conditions, with links to the question in the questionnaire’s Canvas and Routing tabs.
Concepts#
The concept page shows the concept within a navigable tree of its concept system, along with the studies, variables, and questions that use the concept. When you arrive at a concept from a dataset or questionnaire, the related items are limited to that container. Click Show all to remove the limit.