Review metadata

This page covers the review of data descriptions created using SND’s documentation system, DORIS. In this context, “metadata” refers to the information entered in the fields of the DORIS web form, not information included in documentation files or data files.

  • Under General guidance on reviewing metadata, you will find advice on reviewing metadata descriptions as a whole – such as which fields must be completed and how detailed the metadata should be. 
  • Under Reviewing metadata in DORIS, a selection of sections in the data description form is listed with discussion of selected fields to support a review of their content.

Below is a brief overview of what you need to check to ensure that metadata meet the minimum requirements for inclusion in the SND catalogue. These requirements are described in the SND document Requirements and recommendations for data and metadata described and shared through DORIS on Zenodo. 

Information about reviewing data and documentation files can be found on the Review data and Review documentation pages.

General guidance on reviewing metadata

When reviewing metadata for a data description, the starting point is that the researcher who created the description is the person best suited to describe the data. The reviewer’s main task is therefore to ensure that all required fields – and as many relevant optional fields as possible – are completed, and that the content appears reasonable. You are not expected to verify the accuracy of the content, but rather to check that the information provided in each field makes sense considering the accompanying documentation. 

Some minor edits to the metadata may be easiest for you as the reviewer to make directly, such as correcting typos, adding additional keywords, or entering ORCID or ROR IDs. Other fields, such as data collection method, are best completed by the researcher. If you make changes as a reviewer, it is good practice to inform the researcher of what was done and to ask them to approve the catalogue entry preview before publication.

Which metadata fields must be completed?

DORIS has a minimum set of metadata elements that must be provided for a data description to be published. This ensures that research data can be found, accessed, and reused, and that the metadata can be disseminated through other systems. Meeting these minimum requirements is an important step towards following the FAIR principles.

Fields marked with a red symbol (·) in DORIS are mandatory and must be completed before a data description can be published. The required fields vary depending on which subject profile is selected in the form, but some fields are mandatory for all profiles. Non-mandatory fields should still be completed as fully as possible.

Mandatory metadata fields can be provided in Swedish or English, but we recommend to fill out as many fields as possible in both languages. The Description field should always be provided in both languages. The translation does not have to be exact, but the same level of information should be included. For longer descriptions, it may be appropriate to refer to the catalogue entry in the other language, but it is better to leave a field blank than to only provide a reference, as empty fields are automatically populated with information from the entry in the other language.

In fields where terms are selected from a controlled vocabulary, they are automatically translated.

Venn diagram of metadata fields in DORIS

Researchers may submit a data description even if some mandatory fields are missing. In such cases, the reviewer is expected to help provide the missing information. It is technically possible to publish a data description without completing all mandatory fields, but this is not recommended. Such publication should be reserved for exceptional cases; for example, when the PID requirement can be waived (see What applies to data descriptions that only contain metadata? below). A note explaining the missing information should be added to the Notes section in DORIS.

How much information is needed and at what level?

Good metadata strike a balance between general and detailed information. The Description field is especially important. A description should explain the context and nature of the data in a way that is understandable even to researchers outside the field. It should also provide enough detail to allow potential users to quickly assess whether the dataset is relevant and worth exploring further. Other metadata fields, such as those under Collection and method, are typically aimed at a more specialized audience.

Some metadata fields contain links to external sources such as publications, websites, or related resources. These links should, whenever possible, be persistent identifiers, such as a DOI, handle, or URN. If no persistent identifier is available, a standard URL can often be used, but since URLs do not guarantee long-term accessibility, they may need to be verified periodically.

Make sure the metadata are reasonable and useful, that no fields contain meaningless values, and that there are no spelling errors or typos.

What applies to data descriptions that only contain metadata?

DORIS can be used to share metadata for datasets that have already been published elsewhere. This is done by checking the box Data available through another portal/service (only metadata in DORIS). When the data description contains only metadata, review only the metadata and not the linked data. If the data are not made openly available, it is not possible to verify the metadata against the actual dataset or data files. This means that you need to rely on the information provided by the submitter being correct and complete.

Tip! When reviewing data descriptions that only contain metadata, it is good practice to check that the link provided leads to the correct data source and to ensure that the creator, title, and year of publication entered in DORIS match the external data description (if such metadata are available there).

Note: This checkbox should not be used to indicate that data cannot be made openly available; such access restrictions should instead be set using the File access level field.

Data descriptions that only contain metadata are not assigned a DOI in DORIS, as the description does not include a dataset. Instead, an existing persistent identifier for the dataset must be entered in DORIS, in line with SND’s policy for persistent identifiers (PID) on research data on Zenodo. Exceptions to the PID requirement may be made when the data description refers and links to a resource collection (such as a database, catalogue, or portal) that itself contains multiple datasets.

Reviewing metadata in DORIS

Below is a list of the sections included in the DORIS data description form. Each section contains several fields and some of the fields are described in more detail to highlight aspects that may be relevant to review. Keep in mind that the number of visible fields depends on the research area profile selected.

Research area profile 

Whether the selected research area profile is suitable for the data material does not often become clear unit the data description is reviewed. It is possible to change the profile in DORIS even after the data description has been submitted, but subject-specific fields will be cleared if the profile is changed. It is not essential to use the “correct” profile, but selecting an appropriate profile generally improves the quality of the metadata by aligning them with disciplinary practices. 

Access and restrictions 

File access level

Check that the selected file access level aligns with the content of the data – particularly regarding personal or other protected information. If the data contain information that cannot be shared openly (e.g., sensitive personal data), the access level should be set to Contains files with restricted access, which means a request to access the data is required before the data files can be released.

Read more about files containing personal data on the GDPR and personal data page.

Remember that even if data files cannot be made directly downloadable, the documentation files should be. It is important for a prospective data requester to obtain as much information as possible to decide whether the material may be useful to them.

Data contain personal data / Data contain other protected information

It is essential that the information provided here is correct. A detailed review and discussion with the researcher are often needed to verify this. Also indicate what type of personal data are included. This is important for both prospective secondary users and internal processes for assessing requests for access and disclosure of the data.

If it is not possible to fully determine whether personal data are included – for example, due to the size or complexity of the material – we recommend selecting Data contain personal data and using the Description of personal data field to describe any potential risks related to the personal data.

Datasets that contain personal data may only be shared via DORIS if the researcher’s organization has an agreement with SND. This may involve local storage and integration with DORIS, the interim solution, or that the organization has a data processing agreement with SND for using SND CARE.  

Licence and copyright

Ensure that the licence and copyright information do not conflict with the selected file access level, your institution’s local policies, or other applicable frameworks. As an example, datasets with restricted access should not have a Creative Commons licence. 

Files

This section lists the data and documentation files which will be made available in the dataset. If SND CARE is used or if the local storage is integrated with DORIS, the files are uploaded in DORIS. If the organization utilizes local storage through the interim solution, local routines apply for uploading data files. 

For datasets with restricted access, it is particularly important that accompanying documentation files are indicated correctly, as these should be openly accessible in the catalogue entry even if the data files cannot be openly accessible.

Citation and description  

This section includes information that gives visitors an overview of the dataset: title, creator(s), and a description of the data. Much of the information in this section forms the basis for how the dataset will be cited. Most of the information entered here will become a part of the data citation. At the top of this section, a suggested citation for the dataset is provided, which will be visible in the catalogue entry. This makes it easier for users to cite the dataset.

Title

Titles should ideally be provided in both Swedish and English, but this field is exempt from the general bilingual requirement as a suitable Swedish title may not always be available for the purpose of data publication.  

The Alternative title field can be used to enhance discoverability, for example by providing a title in a third language.

Avoid using the same title for the data description as any publication associated with the research results. In such cases, use a title such as “Data for: [Title of the article]”.

Creators/Principal investigators

This may be one or more individuals or organizations. It is relatively uncommon for both individuals and organizations to be listed as the creator/principal investigator of a dataset. An organization may be listed as the creator when the dataset comes from a large research project or collaboration between research groups. For example, the SOM Institute lists the organization as the creator of its surveys. 

The names entered here will be included in the data citation. Individuals or organizations that have contributed but should not be included in the citation should instead be listed in the Contributors field (see next section, Administrative information). Whenever possible, include ORCID IDs for individuals and ROR IDs for organizations to improve interoperability and findability.

If a researcher’s institution does not have an official Swedish name, use the English name in both language fields rather than leaving the Swedish field blank. 

Description

This is a central field in any data description. The Description field should provide users with an overview of what types of data are included and the context in which they were collected or generated.

A good description balances general information, which allows non-specialists to understand the data material and from which research field the dataset originates, and more detailed information, to help researchers with domain expertise assess whether the dataset may be relevant to them for further research. 

Larger and more complex datasets from completed projects may benefit more from broader descriptions aimed at a wider audience, than what smaller, article-specific datasets do. For highly specialized material, it may be acceptable to provide a more targeted, specialized description.

Description is a mandatory field in both Swedish and English. However, the texts do not have to be identical; a shorter summary in Swedish with a reference to the English catalogue page for more information is acceptable.

If you draft a simple description yourself, make sure the researcher reviews and approves it. Consider including a reference in the text to the English page for further information. Always ask the researcher to verify what you have written, especially if the research field is unfamiliar to you.

Administrative information  

It is essential that you provide the correct Research principal (forskningshuvudman), as this determines which organization is responsible for reviewing the dataset, which storage system shall connect to DORIS, and who is responsible for decisions on data access and disclosure. 

Note: You cannot change the research principal afterwards. If the wrong research principal organization has been selected, the researcher must create a new data description. To simplify this, the previous description can be copied using Other actions > Duplicate data description. You may also contact the SND office at snd@snd.se for possible solutions. 

Research principal

Research principal refers to the organization within which the research was conducted and which bears ultimate responsibility for it. If there are multiple research principals, enter the organization responsible for making the data available. You can, for example, ask the researcher which organization is responsible for archiving the data or which organization submitted the application for ethical review. 

Other research principals

This field can be used to list additional research principals, for example in collaborative projects between several organizations. 

In a collaboration between, for example, a university and a regional authority, it may not be clear which organization should be listed as the research principal. The researcher will usually know this, but pay attention in research where the creator and principal investigator come from different organizations, or where the metadata indicate that data have been produced in collaboration by several organizations. Always ask the researcher for clarification if you suspect that something is wrong with the information provided here.

Collection and method  

In the Time periods investigated field, the researcher can specify either a specific temporal coverage with a date range (year, month), or a historical era (e.g., “Bronze Age”). Note that this field does not necessarily refer to the data collection period.

If the person submitting the data description has entered a broad date range (from–to), but only studied selected periods or times within that range, it may be more appropriate to list the individual time periods instead of a larger interval. This will improve the catalogue search results. For example, if the researcher has chosen the range AA–ZZ but the data only cover periods AA, EE, and ZZ, it is better to list AA, EE, and ZZ separately as individual time periods.

Topics and keywords

At least one Research area from Statistics Sweden’s standard classification of fields of research must be provided. Depending on the research field and data type, additional classifications from CESSDA or INSPIRE may be relevant. CESSDA is primarily used for the social sciences, while INSPIRE is recommended for spatial data under the Inspire directive.

Keywords

Keywords improve the findability of data. A data description must include at least one keyword, but the more keywords provided, the more findable the dataset becomes. 

Whenever possible, keywords should be selected from one of the controlled vocabularies. If a suitable term is not available, free-text keywords can be entered. The advanced keyword search allows you to explore terms within specific subject areas and vocabularies. You can also search using the English version of the keyword lists, as some terms do not have Swedish equivalents. 

As a reviewer, you are encouraged to help the researcher by suggesting or adding more keywords.

Geographic coverage 

The section Geographic coverage includes several metadata fields where the researcher can specify the geographic area covered by the data. It is also possible to draw the area on a map, which makes the data description searchable in the map search feature. The area or location will then be illustrated with a map in the catalogue entry. Researchers can also add a free-text description of the geographic coverage or upload GIS data to avoid having to do it twice.

Publications and relations 

Many researchers make their data accessible in connection with the publication of an article. In such cases, it is essential that the article is linked to the data description. A copy of the article should be saved even if it is published Open Access, to ensure the information remains accessible if the original publication becomes unavailable. If a publication describes how the data were created, it is particularly important to link it to the data description. 

Publication information can be imported automatically from SwePub. Always double-check that the imported and automatically generated information is accurate. For larger studies, there may be regularly updated publication lists on project websites. In such cases, the Link to publication list field can be used – but be aware that links may need updating over time.

Additional publications can be added to the catalogue entry later.

Language resources  

The Language resources section only appears if the researcher has selected the Language resources research area profile.