Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cforgaci/dataset-template
https://github.com/cforgaci/dataset-template
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/cforgaci/dataset-template
- Owner: cforgaci
- Created: 2022-05-02T10:45:25.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-09T20:37:00.000Z (about 2 months ago)
- Last Synced: 2024-12-09T21:30:20.865Z (about 2 months ago)
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Dataset title
## Table of Contents
- [1. GENERAL INFORMATION](#1-general-information)
- [2. METHODOLOGICAL INFORMATION](#2-methodological-information)
- [2.1 Research questions, methods and envisioned uses](#21-research-questions-methods-and-envisioned-uses)
- [2.2 Methods for processing the data](#22-methods-for-processing-the-data)
- [2.3 Instrument- or software-specific information](#23-instrument--or-software-specific-information)
- [3. FILE OVERVIEW](#3-file-overview)
- [3.1 File List](#31-file-list)
- [3.2 Relationship between files](#32-relationship-between-files)
- [3.3 File formats and naming conventions](#33-file-formats-and-naming-conventions)
- [4. DATA-SPECIFIC INFORMATION](#4-data-specific-information)
- [4.1 Data Category A](#41-data-category-a)
- [4.2 Data Category B](#42-data-category-b)
- [4.3 Data Category C](#43-data-category-c)
- [4.4 Data Category D](#44-data-category-d)
- [5. SHARING/ACCESS INFORMATION](#5-sharingaccess-information)
- [5.1 Licenses/restrictions placed on the data](#51-licensesrestrictions-placed-on-the-data)
- [5.2 Links to other resources](#52-links-to-other-resources)
- [5.3 Recommended citation for this dataset](#57-recommended-citation-for-this-dataset)
# 1. GENERAL INFORMATION
## 1.1 Title of Dataset
Insert title here
## 1.2 Dataset description
This dataset contains qualitative and/or quantitative data on ... Context for the research project... Additional details about the project can be accessed [here](https://...).
## 1.3 Author Information
A. Principal Investigator
- Name:
- Institution:
- Address:
- Email:
B. Associate or Co-investigator
- Name:
- Institution:
- Address:
- Email:
C. Associated study personnel
- ...
- ...
## 1.4 Dates of data collection
- Survey 1: YYYY-MM-DD
- Survey 2: YYYY-MM-DD
## 1.5 Geographic location of data collection
...
## 1.6 Keywords
..., ..., ...
## 1.7 Language
...
## 1.8 Information about funding sources that supported the collection of the data
This research project was funded by...
# 2. METHODOLOGICAL INFORMATION
## 2.1 Research questions, methods and envisioned uses
Insert brief overarching summary of methods...
### 2.1.1 Research question 1: ...?
- Instrument 1 (quan/qual)
- Instrument 2 (quan/qual)
### 2.1.2 Research question 2: ...?
- Instrument 1 (quan/qual)
- Instrument 2 (quan/qual)
### 2.1.3 Envisioned uses of the dataset
- ...
- ...
## 2.2 Methods for processing the data
- ...
- ...
## 2.3 Instrument- or software-specific information
- Software version X.X was used for ...
# 3. FILE OVERVIEW
Are there multiple versions of the dataset? Yes/No
## 3.1 File List
### 3.1.1 Data category A
- "filename.extension": brief description of file
### 3.1.2 Data category B
- "filename.extension": brief description of file
### 3.1.3 Data category C
- "filename.extension": brief description of file
### 3.1.4 Data category D
- "filename.extension": brief description of file
## 3.2 Relationship between files:
The following tables (csv files) employ a foreign key to refer to the primary key (unique identifier) in one or more other table(s):
"filename.extension"
- abc used as foreign key to "otherfile.extension"
## 3.3 File formats and naming conventions
### 3.3.1 File formats
- extension - type of data
### 3.3.2 Naming conventions
- files named lower case, spaces replaced with dashes (dash-case)
- in tabular data, variable names snake case
# 4. DATA-SPECIFIC INFORMATION
- Missing data code: NA
- Not Applicable: N/A
## 4.1 Data Category A
### 4.1.1 filename.extension
1. Number of variables:
2. Number of cases/rows:
3. Variable List:
"variable_name"
- Full name:
- Description:
- Type of variable:
- Unit of measurement:
- Number of missing values:
4. Specialised formats or other abbreviations used:
5. Total file size:
## 4.2 Data Category B
...
## 4.3 Data Category C
...
## 4.4 Data Category D
...
# 5. SHARING/ACCESS INFORMATION
## 5.1 Licenses/restrictions placed on the data:
...
## 5.2 Links to other resources:
### 5.2.1 Links to publications that cite or use the data:
...
### 5.2.2 Links to other publicly accessible locations of the data:
...
### 5.2.3 Links/relationships to ancillary data sets:
...
### 5.2.4 Links to publicly accessible scripts for analysis of the dataset:
- [Link title](link url)
### 5.2.5 Was data derived from another source?
Yes/No
## 5.3 Recommended citation for this dataset:
...
This README.md file template was generated on 2022-04-19 by Claudiu Forgaci and Adele Therias according to the 4TU.ResearchData [Guidelines for creating a README file](https://data.4tu.nl/info/en/use/publish-cite/upload-your-data-in-our-data-repository) and the Cornell University template [Guide to writing "readme" style metadata](https://cornell.app.box.com/v/ReadmeTemplate) and is licensed under CC BY 4.0