Skip to content

ShareTrait Database — a relational SQL database providing a structured implementation of the ShareTrait data. It includes the full schema definition, data tables and supporting documentation.

License

Notifications You must be signed in to change notification settings

ShareTraitProject/ShareTraitDatabase

Repository files navigation

ShareTrait DataBase SQL

This repository contains the ShareTrait DataBase (STDB) SQL of ShareTrait Project

Latest release version

Last modified: 2025-09-25

The most recent release of this repository is archived in Zenodo.

  • Release Title: sharetrait-db v1.0.0
  • Version: v1.0.0
  • Database Reference: ShareTraitDatabase
  • Release DOI: DOI
  • GitHub Release: GitHub Release

This release snapshot contains the validated dataset, metadata, and code associated with version v1.0.0.
Please use the DOI when citing this resource in publications.

📝 Please take a look at the #general-release-version-overview section for the overview of the information found in this release

Repository Structure

The SharetraitDatabase repository is structured as follows. Only the ShareTraitDatabase repository is described

ShareTraitProject/
├── ShareTrait
├── ShareTraitDatabase/
|   ├── README.md
|   ├── CITATION.cff
|   ├── CONTRIBUTORS
|   ├── LICENSE
|   ├── db
│   │   ├── STdb_v01/
│   │   ├── stdb-all/
│   │   ├── README.md
|   ├── diagrams
|   ├── documentation
|   ├── mappings
│   │   ├── attribute_mapping_v02/
│   │   ├── attribute_mappings_v01/
│   │   ├── dataset-db-attributes-mapping-v1/
│   │   ├── README.md
|   ├── queries
│   ├── sharatrait-database-v1/
│   │   ├── db-documentation/
│   │   ├── db-export/
│   │   ├── db-publish/
│   │   ├── db-queries/
│   │   ├── db-tables/
│   │   ├── db-tools/
|   ├── tables

---

Repository general description

Hereby we describe the general content found for each folder of the directory. Please make sure you look at the README.md files within each sub-folder for more information regarding the file content and usage.

folder name description last modified
db sharetrait database sql test versions 2024-06-12
diagrams database sketch backup schemas and models versions 2024-08-18
documentation definitions and description of the ER model 2024-08-01
mappings mappings for aligning db attributes to sharetrait previous versions 2024-11-05
queries questions queries mapping for selecting data 2024-09-13
sharetrait-database-v1* v1.0.0 of sharetrait database 2025-07-25
tables list of data files to populate database 2024-11-04

General release version overview

The folder sharetrait-database-v1 includes the complete data package prepared for release version. The sharetrait-database-v1, v1.0.0 is complete of: relational schema, organised data tables, and supporting documentation to allow local setup and use of the database. In addition to the full documentation of the design and implementation, version 1.0.0 includes tools and content that facilitate direct data access, integration, and query sharetrait data. Please refer to the README.md files within each sub-folder for detailed guidance on file content and usage.

sharetrait-database-v1 folder overview structure

The sharetrait-database-v1 folder as referred in this release version GitHub Release, this includes the following components:

sub-folder name description
db-documentation/ Contains documentation, schema design, database component definitions, dictionaries, and mappings to the ShareTrait dataset.
db-export/ Provides the ShareTrait database in SQL format for version 1.0.0.
db-publish/ Lists documentation and files used in publications linked to this database version.
db-queries/ Includes example SQL queries, views and outputs (csv format) based on biological research questions.
db-tables/ Contains CSV files with data values and mappings for importing into the ShareTrait tables.
db-tools/ Includes Python scripts for creating and interacting with the database.

Important

📣 The db-documentation sub-folder contains the current data dictionary v1.0.0, ShareTrait-database-attributes-definition.csv.

This data dictionary is based on the ShareTrait-database-schema-v1.png design and it contains as well the mapping to the ShareTrait_MetaData_v1.0.0.csv, with attribute name sharetrait_dataset_col_name.

Access and usage of the DB and SQL files

Tip

Please follow the instructions provided in the repository’s documentation version 1.0, db-documentation/ and the specific folders' README.md files. For setting up the db locally, start with the documentation found in the sub-folders db-export/ and db-tools/ for database setup.

Support

For any questions about ShareTraitDataBase v1.0.0, you can contact Irene

Extra information

The SharetraitDatabase repository is part of ShareTraitProject (https://github.com/ShareTraitProject)


Note

Please note that this repository is active. For the latest version, please refer to the latest database release folder v1.0.0 GitHub Release
release version maps to the bu folder: sharetrait-database-v1, last modified on 2025-07-23

About

ShareTrait Database — a relational SQL database providing a structured implementation of the ShareTrait data. It includes the full schema definition, data tables and supporting documentation.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages