This is the blog section. It has two categories: News and Releases.
Files in these directories will be listed in reverse chronological order.
This is the multi-page printable view of this section. Click here to print.
ready4 Framework Blog
Releases
Dataset releases
All current and previous releases of framework datasets.
Framework taxonomies dataset releases
Releases of the dataset of taxonomies used to help standardise code authoring and documentation.
Releases of the datasets of the taxonomies that support a consistent code house-style and automation of documentation autoring are described below.
| Date | Dataset | Version | Number of files |
|---|---|---|---|
| 23-Dec-2022 | ready4 Framework Abbreviations and Definitions | 3.0 | 1 |
| 25-May-2022 | ready4 Framework Abbreviations and Definitions | 2.1 | 1 |
| 14-Jan-2022 | ready4 Framework Abbreviations and Definitions | 2.0 | 1 |
| 14-Jan-2022 | ready4 Framework Abbreviations and Definitions | 1.0 | 1 |
Library releases
All current and previous releases of framework and module libraries.
Framework library releases
Releases of foundation and authoring tools libraries to implement the ready4 framework.
Currently available (as at 11-Jun-2024) releases of framework libraries are described below.
| Date | Package | Release | Description |
|---|---|---|---|
| 16-Apr-2024 |
|
0.1.9 | ready4 provides a programming syntax, a template model module and tools to help maintain a modular and open-source health economic model’s project documentation website. These elements are the foundation for a prototype software framework to support replicable and transferable health economic models. The software framework is extended by other R libraries.Full Changelog: v0.0.0.9102…v0.1.9 |
| 13-Sep-2022 |
|
0.0.0.90985 | ready4show provides tools for authoring technical documentation, analysis reports and scientific summaries to showcase insights generated by open, modular mental health system models.This release corrects citation information. |
| 13-Sep-2022 |
|
0.0.0.92225 | ready4use provides a set of tools for authoring and working with datasets when developing open source, modular mental health systems models.This release corrects package citation details. |
| 13-Sep-2022 |
|
0.0.0.90981 | ready4show provides tools for authoring technical documentation, analysis reports and scientific summaries to showcase insights generated by open, modular mental health system models.This release corrects citation information. |
| 13-Sep-2022 |
|
0.0.0.9222 | ready4use provides a set of tools for authoring and working with datasets when developping open source, modular mental health systems models. |
| 13-Sep-2022 |
|
0.0.0.9098 | ready4show provides tools for authoring technical documentation, analysis reports and scientific summaries to showcase insights generated by open, modular mental health system models.This release contains very minor updates. |
| 13-Sep-2022 |
|
0.0.0.9102 | ready4 provides the foundational elements (classes, generics, methods, functions) of a framework for implementing open source youth mental health systems modelling projects.This release includes a number of additional helper functions. |
| 08-Sep-2022 |
|
0.0.0.92220 | updated for fns_dmt_tb |
| 08-Sep-2022 |
|
0.0.0.9221 | updated for fns_dmt_tb |
| 08-Sep-2022 |
|
0.0.0.90981 | added fns_dmt_tb to release |
| 08-Sep-2022 |
|
0.0.0.90980 | added fns_dmt_tb to release |
| 19-Apr-2022 |
|
0.0.0.9096 | ready4show provides tools for authoring technical documentation, analysis reports and scientific summaries to showcase insights generated by open, modular mental health system models.This release references an updated R Markdown subroutine for generating scientific manuscripts. |
| 15-Feb-2022 |
|
0.0.0.92201 | ready4use provides a set of tools for authoring and working with datasets when developping open source, modular mental health systems models.This release corrects an error with the citation file. |
| 15-Feb-2022 |
|
0.0.0.90951 | ready4show provides tools for authoring technical documentation, analysis reports and scientific summaries to showcase insights generated by open, modular mental health system models.This release corrects an error in the citation file. |
| 15-Feb-2022 |
|
0.0.0.90891 | ready4 provides bare bones foundational elements (classes, generics, methods, functions) of a framework for ensuring that the computational model components of mental health systems modelling projects adhere to open science principles.This release fixes an error in the CITATION.cff file. |
| 15-Feb-2022 |
|
0.0.0.9220 | ready4use provides a set of tools for authoring and working with datasets when developing open source, modular mental health systems models. |
| 14-Feb-2022 |
|
0.0.0.9095 | ready4show provides tools for authoring technical documentation, analysis reports and scientific summaries to showcase insights generated by open, modular mental health system models.This release includes minor updates including addition of a CITATION.cff file. |
| 14-Feb-2022 |
|
0.0.0.9089 | ready4 provides bare bones foundational elements (classes, generics, methods, functions) of a framework for ensuring that the computational model components of mental health systems modelling projects adhere to open science principles.This release includes minor updates including new functions to generate CITATION.cff files and update the dictionary of recognised terms for the coding house-style. |
| 14-Feb-2022 |
|
0.0.0.9088 | Minor updates and fixes. |
| 14-Jan-2022 |
|
0.0.0.9078 | Release with first version of Framework syntax and foundational Ready4Module. Vignettes include details of initial applications of framework. |
| 29-Oct-2021 |
|
Documentation | fix of write to repo fn |
| 29-Oct-2021 |
|
0.0.0.9461 | First release indexed with a Zenodo DOI. |
| 28-Oct-2021 |
|
0.0.0.9022 | Initial release of ready4 R package |
| 26-Oct-2021 |
|
0.0.0.9048 | Data release |
| 26-Oct-2021 |
|
Doc_0.0 | more s4 mthd dmtn fixes |
| 08-Apr-2021 |
|
0.0.0.9122 | This release includes some changed argument names and updated documentation.The user documentation ready4use_user_0.0.0.9122.pdf is the manual that is recommended for most package users as it lists only functions intended for use. There is an extended version of the manual ready4use_developer_0.0.0.9122.pdf) that provides a full list of all functions in the package (potentially including buggy, poorly tested in development functions or helper functions not meant for end-users), but this is only potentially useful for developers who want a quick guide to what’s under the hood. |
| 07-Apr-2021 |
|
0.0.0.9120 | This release addresses a build failure in the previous release due to a improper class creation.The user documentation ready4use_user_0.0.0.9120.pdf is the manual that is recommended for most package users as it lists only functions intended for use. There is an extended version of the manual ready4use_developer_0.0.0.9120.pdf that provides a full list of all functions in the package (potentially including buggy, poorly tested in development functions or helper functions not meant for end-users), but this is only potentially useful for developers who want a quick guide to what’s under the hood. |
| 07-Apr-2021 |
|
0.0.0.9119 | This release addresses a build failure in the previous release due to a problematic dependency.The user documentation ready4use_user_0.0.0.9119.pdf is the manual that is recommended for most package users as it lists only functions intended for use. There is an extended version of the manual ready4use_developer_0.0.0.9119.pdf that provides a full list of all functions in the package (potentially including buggy, poorly tested in development functions or helper functions not meant for end-users), but this is only potentially useful for developers who want a quick guide to what’s under the hood. |
| 07-Apr-2021 |
|
0.0.0.9193 | This release includes updated dependencies to address potential build problems.The user documentation ready4class_user_0.0.0.9193.pdf is the manual that is recommended for most package users as it lists only functions intended for use. There is an extended version of the manual ready4class_developer_0.0.0.9193.pdf that provides a full list of all functions in the package (potentially including buggy, poorly tested in development functions or helper functions not meant for end-users), but this is only potentially useful for developers who want a quick guide to what’s under the hood. |
| 07-Apr-2021 |
|
0.0.0.9289 | Updates from previous release include adding an internal helper function for removing labels from dataframes that replaces a dependency that was causing build fails on Mac installs.The user documentation ready4fun_user_0.0.0.9289.pdf is the manual that is recommended for most package users as it lists only functions intended for use. There is an extended version of the manual ready4fun_developer_0.0.0.9289.pdf that provides a full list of all functions in the package (potentially including buggy, poorly tested in development functions or helper functions not meant for end-users), but this is only potentially useful for developers who want a quick guide to what’s under the hood. |
| 07-Apr-2021 |
|
0.0.0.9189 (Initial) | This is the initial release of the ready4class package.The user documentation ready4class_user_0.0.0.9189.pdf is the manual that is recommended for most package users as it lists only functions intended for use. There is an extended version of the manual ready4class_developer_0.0.0.9189.pdf that provides a full list of all functions in the package (potentially including buggy, poorly tested in development functions or helper functions not meant for end-users), but this is only potentially useful for developers who want a quick guide to what’s under the hood. |
| 07-Apr-2021 |
|
0.0.0.9279 | Updates from previous release include (another) bug fix for the write_links_for_website function.The user documentation ready4fun_user_0.0.0.9279.pdf is the manual that is recommended for most package users as it lists only functions intended for use. There is an extended version of the manual ready4fun_developer_0.0.0.9279.pdf that provides a full list of all functions in the package (potentially including buggy, poorly tested in development functions or helper functions not meant for end-users), but this is only potentially useful for developers who want a quick guide to what’s under the hood |
| 06-Apr-2021 |
|
0.0.0.9187 | updated v nbr |
| 06-Apr-2021 |
|
0.0.0.9186 | updates to authoring workflow |
| 01-Apr-2021 |
|
0.0.0.9278 | Updates from previous release include bug fixes for the write_links_for_website.The user documentation (ready4fun_user_0.0.0.9278.pdf) is the manual that is recommended for most package users as it lists only functions intended for use. There is an extended version of the manual (ready4fun_developer_0.0.0.9278.pdf) that provides a full list of all functions in the package (potentially including buggy, poorly tested in development functions or helper functions not meant for end-users), but this is only potentially useful for developers who want a quick guide to what’s under the hood. |
| 01-Apr-2021 |
|
0.0.0.9276 | Updates from previous release includes some function and argument renaming (to improve self-documentation), improvements to the write_links_for_website function and reduction of the number of functions listed in the default user manual. This release comes bundled with two versions of package documentation. The user documentation (ready4fun_user_0.0.0.9276.pdf) is the manual that is recommended for most package users as it lists only functions intended for use. There is an extended version of the manual (ready4fun_developer_0.0.0.9276.pdf) that provides a full list of all functions in the package (potentially including buggy, poorly tested in development functions or helper functions not meant for end-users), but this is only potentially useful for developers who want a quick guide to what’s under the hood. |
| 30-Mar-2021 |
|
0.0.0.9270 (Initial) | Initial releaseThis initial release of the ready4fun package includes functions that have been successfully deployed to help author other packages in the ready4 suite. However, only self-authored documentation (i.e. documentation created by the functions contained in ready4fun) is available in this release. We intend expanding on this very basic documentation in future releases. |
News About ready4
ready4 PharmacoEconomics article
The ready4 framework is introduced in an article from the PharmacoEconomics journal.
The ready4 framework has achieved another milestone with the publication of the first peer-reviewed article relating to its development and application.
The first peer-reviewed publication describing the ready4 software framework is now available in PharmacoEconomics. Thank you to the co-authors, advisers and peer-reviewers who helped achieve this outcome.
ready4 is now on CRAN
Announcing the first CRAN release of the ready4 library.
The ready4 framework has reached a major milestone with the inclusion on CRAN of the ready4 foundation library.
The first of the six libraries that comprise the ready4 software framework is now available on CRAN. Thank you to the volunteer peer-reviewers who took the time to review our submissions and help ensure that the library was compliant with all required CRAN policies.
Introducing ready4 framework modules and syntax
Announcing the introduction of a novel approach to developing modular models with a simple, consistent syntax.
The ready4 framework has reached a major milestone with the launch of tools to implement modular models that use a simple and consistent syntax.
Development version software to implement and extend the ready4 framework has been publicly available for over a year now. However, the way that this code was limited has limited its potential utility as a toolkit for developing transparent and modular mental health systems models. The latest release of the ready4 R package addresses these limitations with two important innovations:
-
introducing the concept of modules, to facilitate consistent application of an Object Oriented Programming approach throughout the ready4 software suite;
-
codifying a simple and consistent syntax for use in all programs that implement configurations of models developed with the ready4 framework.
To view or cite the archive copy of the version of the ready4 package which introduced these innovations use https://doi.org/10.5281/zenodo.5847544. To view or cite the most recently archived copy of the ready4 package use https://doi.org/10.5281/ZENODO.5606250. The latest documentation for the package is available at https://ready4-dev.github.io/ready4/
ready4 software now archived on Zenodo
Announcing the ready4 Zenodo community.
The software that we create to implement the ready4 framework and the models developed with that framework will from this point forward be archived on Zenodo.
Zenodo is an open science platform developed by CERN and using it as a repository for archiving our software has a number of advantages:
- it creates a permanent copy of each software item, thus making these items appropriate for citation in peer-reviewed journal articles (unlike software stored in impermanent development code repositories such as GitHub);
- it create DOI identifiers for each archived software item, minting a new DOI for each version of a software item sent for archiving as well as providing a catch all DOI that can apply to all versions of the software;
- it provides a simple workflow to integrate with GitHub repositories (where our most up to date development code is stored);
- it automatically submites archived items for indexing on OpenAire; and
- it includes easy to use citation tools to help generate appropriate citations for software in multiple output formats.
We have established a ready4 community within Zenodo, in which all our code is stored.