ReadMe File Generator

URGE (USN Readme File Generator) is a comprehensive tool designed to create detailed and standardized README files for datasets in accordance with the FAIR principles (Findable, Accessible, Interoperable, and Reusable).

Key features:

Multiple import options: Import from SIKT DMP, existing README files, or Dataverse
Smart metadata handling: Automatically fetch and populate metadata from Dataverse
Grammar checking: Built-in grammar checker to ensure high-quality documentation
Flexible export: Generate both standard and anonymous README files
JSON support: Export metadata in JSON format for machine readability
Interactive interface: User-friendly form with tooltips and helpful guidance

Benefits:

Ensures consistency in dataset documentation
Facilitates data sharing and reuse
Supports compliance with data management standards
Enhances dataset discoverability and citation

URGE is an essential tool for researchers, data managers, and institutions committed to maintaining high standards of data documentation and sharing in the scientific community.

No data entered in this form is stored on our servers.

Data Import

Import via API (Token and DOI) API info DOI info

Import via Private URL

Upload your DMP file in JSON format:

Only Methodology

Note: You can select a JSON file previously exported from this tool to fill all form fields exactly as saved. Alternatively, upload a TXT readme file to extract as much information as possible into the form; parsing depends on the file structure and may not populate every field.

Upload your JSON file:

Use TXT readme file instead

General Information

Title of Dataset:

Please enter a title for the dataset.

Enter the title of your dataset.

DOI:

Please enter a DOI for the dataset.

Enter the DOI of your dataset.

Contact Information

The person to be contacted for questions about the dataset

Name:

Please enter your Family name, Given name.

Institution:

Email:

Please enter your email.

ORCID:

Before the Readme.txt file is created, the following information must be registered in the metadata schema of DataverseNO. In the text below, mark the applicable fields/lines. If you have activated the Dataverse Import section above, this data will be automatically retrieved from DataverseNO.

Contributors: Check to retrieve from Dataverse

Data Type: Check to retrieve from Dataverse

Date of data collection/generation: Check to retrieve from Dataverse

Geographic location: Check to retrieve from Dataverse

Funding sources: Check to retrieve from Dataverse

Description of Dataset

(Short) description of what the dataset is about, including reference to related project(s) and publication(s), if applicable. Should correspond to the information entered in the metadata fields Description and Related Publication.

Please write a description that identifies the Database

Methodology

Note! If the documentation referred to is not openly available through a persistent URL, it must be added here or uploaded as file(s) to the dataset.

Note! It may generally be considered appropriate to have overlap in the methods section of a research data README file with citation of the original article. See Committee on Publication Ethics (COPE) guidance on text recycling: text recycling:

Description of Sources and Methods Used For Collection and/or Generation of Data

Methods For Processing The Data:

Add valid sections to the form below

Facility-, instrument- or software-specific information needed to interpret the data:

Standards and calibration information:

Environmental/experimental conditions:

Describe any quality-assurance procedures performed on the data:

File Information

Add valid sections to the form below

Relationship between files, if important:

Is this an updated version of a dataset published on DataverseNO? yes/no

File List:

Please enter information about the files/folders inside the Database

Original filename	Status	Reason	Recommended action	Suggested new name	Suggested new format

Data-Specific Information For:

Repeat this section for each file, as appropriate. Recurring items may also be explained in a common initial section.

For TABULAR data provide a data dictionary/code book containing the following information:.

Variable/Column List:
List variable/column name(s), description(s), unit(s) of measurement, decimal separator (comma or point), value labels, and source(s) as appropriate for each.

Missing data codes:
Define codes or symbols used to indicate missing data.

Specialized formats or other abbreviations used:

For QUALITATIVE data (e.g. interviews, images), provide a data list:

Data List:
The data list should contain the following information, as appropriate: interview identifier (ID); age; gender; occupation, organisation; location; place of interview; date of interview; transcript file name. Information included should be detailed enough to enable sub-setting and filtering, but not detailed enough to enable identification of participants where confidentiality has been promised.

Contextual Information:
Where applicable, provide biographical or other contextual information relating to the interview or interviewee, either embedded at the beginning of the transcript files, as a summary page, or added below, as appropriate.

Sharing

Whenever applicable, the following information should be registered in the metadata schema of DataverseNO. In the text below, mark the fields that apply. If you have activated the Dataverse Import section above, this information will be automatically retrieved from DataverseNO

Licenses/Restrictions: See Terms tab.
Links to publications that cite or use the data: See metadata field Related Publication.
Links/relationships to related data sets: See metadata field Related Datasets.
Data sources: See metadata field Data Sources.
Recommended citation: See citation generated by repository
EndNote XML RIS BibTeX

The ReadMe File Generator is based on USN ReadMe File template which is adapted from the following documents/resources:
Conzett, Philipp. (2024). DataverseNO README File Template - General (2.4). Zenodo

Contacts: forskningsdata@usn.no

URGE - Dataverse v1.2

© 2024 USN

URGE – README FILE GENERATOR FOR DataverseNO

Data Import

General Information

Contact Information

The person to be contacted for questions about the dataset

Description of Dataset

Methodology

Description of Sources and Methods Used For Collection and/or Generation of Data

Methods For Processing The Data:

Add valid sections to the form below

Facility-, instrument- or software-specific information needed to interpret the data:

Standards and calibration information:

Environmental/experimental conditions:

Describe any quality-assurance procedures performed on the data:

File Information

Add valid sections to the form below

Relationship between files, if important:

Is this an updated version of a dataset published on DataverseNO? yes/no

File List:

Data-Specific Information For:

Repeat this section for each file, as appropriate. Recurring items may also be explained in a common initial section.

Sharing

Whenever applicable, the following information should be registered in the metadata schema of DataverseNO. In the text below, mark the fields that apply. If you have activated the Dataverse Import section above, this information will be automatically retrieved from DataverseNO

URGE - Dataverse v1.2

© 2024 USN

File Location

URGE – README FILE GENERATOR FOR DataverseNO

About URGE

Data Import

Dataverse Metadata Import

SIKT DMP Import

Readme Import

General Information

Contact Information

The person to be contacted for questions about the dataset

Description of Dataset

Methodology

Description of Sources and Methods Used For Collection and/or Generation of Data

Methods For Processing The Data:

Add valid sections to the form below Facility-, instrument- or software-specific information needed to interpret the data: Standards and calibration information: Environmental/experimental conditions: Describe any quality-assurance procedures performed on the data:

File Information

Add valid sections to the form below Relationship between files, if important: Is this an updated version of a dataset published on DataverseNO? yes/no

File List:

Data-Specific Information For:

Repeat this section for each file, as appropriate. Recurring items may also be explained in a common initial section.

Sharing

Whenever applicable, the following information should be registered in the metadata schema of DataverseNO. In the text below, mark the fields that apply. If you have activated the Dataverse Import section above, this information will be automatically retrieved from DataverseNO

Add valid sections to the form below

Facility-, instrument- or software-specific information needed to interpret the data:

Standards and calibration information:

Environmental/experimental conditions:

Describe any quality-assurance procedures performed on the data:

Add valid sections to the form below

Relationship between files, if important:

Is this an updated version of a dataset published on DataverseNO? yes/no