Skip to content

Releases: AustralianBioCommons/gen3schemadev

v2.3.3

24 Oct 00:45
69d1d06

Choose a tag to compare

What's Changed

Full Changelog: v2.3.2...v2.3.3

v2.3.2

24 Oct 00:24
801c3c5

Choose a tag to compare

What's Changed

Full Changelog: v2.3.1...v2.3.2

v2.3.1

23 Oct 23:27

Choose a tag to compare

Full Changelog: v2.3.0...v2.3.1

  • Fix added, rule validator now checks that data_type, data_category, and data_format are props in a data_file node

v2.3.0

23 Oct 05:18

Choose a tag to compare

What's Changed

Full Changelog: v2.2.0...v2.3.0

v2.2.0

20 Oct 06:58

Choose a tag to compare

What's Changed

Full Changelog: v2.1.1...v2.2.0

v2.1.1

17 Oct 00:19
6d6f229

Choose a tag to compare

What's Changed

  • Fixed typo in lipidomics_file.yaml where link name core_metdata_colleโ€ฆ by @JoshuaHarris391 in #38

Full Changelog: v2.1.0...v2.1.1

v2.1.0

16 Oct 04:54

Choose a tag to compare

Release Notes - Version 2.1.0

New Features

  • Added 'init' command to CLI for schema initialisation
  • Added project schema generation functionality
  • Added rule validation functionality and schema examples

Enhancements

  • Added required properties to output schema in populate_template function
  • Added additionalProperties field to gen3_metaschema.yml
  • Added option to include all schemas in CLI validation
  • Enhanced CLI validation process with exclusion list for schemas
  • Added script to generate schema examples in YAML format

Bug Fixes

  • Fixed data_file category to properly add data_file property reference
  • Updated namespace handling in converter and schema templates
  • Added core_metadata_collections to data_file properties

Refactoring

  • Refactored CLI validation process to improve code clarity
  • Refactored resolve_schema function to return dictionary instead of list
  • Removed bundled_schema_to_list_dict function

Documentation

  • Updated settings template to include versioning information

What's Changed

Full Changelog: v2.0.11...v2.1.0

v2.0.11

15 Oct 01:13
5b63791

Choose a tag to compare

Gen3SchemaDev V2 Release

We're excited to announce a new release of Gen3SchemaDev, a comprehensive toolkit for developing Gen3 data dictionaries.

What's New

This release includes extensive documentation and learning materials to help you create robust data models in Gen3:

Getting Started

  • Quickstart Guide: Jump straight into using Gen3SchemaDev as a data modelling tool
  • First Dictionary Tutorial: Step-by-step guide to creating your first Gen3 dictionary
  • Troubleshooting Resources: Common issues and solutions

Documentation

  • Core Concepts: Essential data modelling principles and FAIR data concepts
  • Deep Dive Materials: Comprehensive coverage of Gen3 dictionary structure, schemas, descriptors, links, and properties
  • Practical Examples: Real-world schema examples to accelerate your learning

For Developers

  • Simplified installation via Poetry
  • Test suite included
  • Clear contributing guidelines
  • Apache 2.0 licence

Community Contributions Welcome

We're actively seeking contributions in two key areas:

  1. Maintaining the Gen3 metaschema
  2. Expanding business rule logic in the rule validator module

Check out our contributing guidelines to get involved.

Special Thanks

Special acknowledgement to Marion Shadbolt for providing the foundational source material.

Get started today: Gen3SchemaDev Repository

What's Changed

Full Changelog: v1.0.0...v2.0.11

v1.0.0

13 Oct 04:20

Choose a tag to compare

First version of gen3schema dev. Uses google sheets, and various containers to facilitate dictionary modelling, bundling, and some preliminary validation

v0.1.0

15 Jan 02:18

Choose a tag to compare

๐Ÿ“ฆ gen3schemadev Release - Archival Milestone

This release archives the current state of the gen3schemadev repository as it transitions to focus exclusively on data modeling and schema development. Previously, the repository supported tasks such as data generation, upload, synthetic file generation, and API-based data manipulation. These functionalities will no longer be the focus.


๐Ÿ”ง Release Details

๐Ÿ—‚๏ธ Repository Summary

This repository provides tools for automating processes in the Gen3 ecosystem, specifically:

  • ๐Ÿ“˜ Data dictionary creation
  • ๐Ÿ“Š Data simulation
  • โœ… Metadata validation
  • ๐Ÿ“ค Data submission

๐Ÿ”‘ Key Features

1๏ธโƒฃ gen3schemadev: Object-Relational Mapper for Gen3 Schemas

  • Converts spreadsheets into YAML files for building Gen3 Data Dictionaries.
  • Example tool: sheet2yaml.py

2๏ธโƒฃ Workflow for Editing Project Dictionaries

  • Edits made in Google Sheets.
  • YAML schemas generated and validated locally.
  • Simulated data created, validated, and uploaded to Gen3.
  • Indexing services configured to integrate new dictionaries.

3๏ธโƒฃ sheet2yaml-CLI.py: Command-Line Tool

  • Generates schemas from Google Sheets/tabs formatted according to the provided template.

4๏ธโƒฃ Plausible Data Generator

  • Enhances simulated data by replacing random values with plausible ones based on defined distributions.
  • Input: JSON files and a CSV or Google Sheet describing plausible values.
  • Output: Edited JSONs and optional dummy sequencing/lipid files.

Example Usage:

python3 plausible_data_gen.py --path <PATH_TO_SIM_DATA> [--values <PATH_TO_CSV> | --gurl <GOOGLE_SHEET_URL>] --generate-files --file-types aligned_reads 

5๏ธโƒฃ Metadata Validator

  • Validates metadata against defined schemas.
  • Includes a user guide and Jupyter notebook example.

6๏ธโƒฃ Gen3 Data Submitter

  • Automates data submission to Gen3 with detailed usage instructions.

๐Ÿ“Œ Supported Workflows

  • ๐Ÿ› ๏ธ Schema Development: YAML generation from spreadsheets.
  • ๐ŸŽ›๏ธ Data Simulation: Plausible dataset creation and refinement.
  • ๐Ÿ“‘ Metadata Validation: Schema compliance checks.
  • ๐Ÿš€ Data Submission: Automated upload and indexing in Gen3.

๐Ÿ”ฎ Moving Forward

The repository will now focus exclusively on data modeling and schema development. Other functionalities will no longer be maintained or supported.

What's Changed

Full Changelog: https://github.com/AustralianBioCommons/gen3schemadev/commits/v0.1.0