Framework library releases
Releases of foundation and authoring tools libraries to implement the ready4 framework.
Releases of foundation and authoring tools libraries to implement the ready4 framework.
Releases of programs for implementing modelling analyses.
Releases of subroutines used in modelling analyses.
The ready4 framework foundation is the first ready4 library you should install.
Instructions for installing the ready4class, ready4fun and ready4pack libraries.
Instructions for installing the ready4use library.
Depending on how you plan to use ready4, you may need to install some or all of its authoring tools.
Releases of module libraries for modelling people (collectively, the Spring To Life model).
Instructions for installing the ready4show library.
We created a basic synthetic dataset of to represent a clinical youth mental health sample.
To implement a modelling analysis with ready4 you need to install computational model modules.
Programs are used to generate and report a model analysis.
Subroutines perform part of an analysis and reporting algorithm.
ready4 is a suite of software, with each included item performing a distinctive role.
The software to help ensure that the ready4 model adheres to consistent standards is distributed as a collection of framework code libraries.
ready4 software is implemented using a combination of object-oriented and functional programming paradigms.
ready4 uses an object oriented programming (OOP) paradigm to implement computational models.
The ready4class R package supports partially automated and standardised workflows for defining the data structures to be used in computational models.
ready4 uses functional programming to maximise the re-usability of model algorithms.
ready4 supports a modular approach to computational model development.
ready4 modules use a simple and consistent syntax.
The ready4fun R package supports standardised approaches to code authoring that facilitate partial automation of the documenting of model algorithms.
ready4 supports tools to streamline the testing, description and distribution of computational model modules.
Replication programs for designing, analysing and reporting discrete choice experiments.
Replication programs for constructing synthetic populations.
Replication programs for developing, finding and applying utility mapping algorithms.
Decision aids provide user interfaces that make it easy to generate practical insight from ready4.
The code used when applying ready4 to a number of real world youth mental health policy and research projects is publicly available.
Sub-routine programs can be used to automatically generate standardised reports of analyses undertaken with ready4.
The ready4use R package provides tools for supplying data to youth mental health computational models.
Online open access data repositories are the preferred storage locations for ready4 model datasets.
The retrieval and dissemination of data from online data repositories is an essential enabler of open source modelling. This tutorial describes how a module from the ready4use R package can help you to manage this process.
Tools from the ready4show R package support authoring of scientific summaries of analyses with ready4.
Appending appropriate metadata to datasets of individual unit records can facilitate partial automation of some modelling tasks. This tutorial describes how a module from the youthvars R package can help you to add metadata to a youth mental health dataset so that it can be more readily used by other ready4 modules.
A tutorial from the Acumen website about using ready4 to search and retrieve data from the Australian Mental Health Systems Models Dataverse.
Pairing a dataset with its dictionary makes it easier to interpret. This tutorial describes how a module from the ready4use R package can help you to pair a dataset and its dictionary.
Vector based classes can be used to help validate variable values. This tutorial describes how to do that with sub-module classes exported as part of the youthvars R package.
Tools from the ready4show R package support authoring of programs and subroutines to implement and report analyses with ready4.
Using modules from the scorz R package, individual responses to a multi-attribute utility instrument survey can be converted into health utility total scores. This tutorial describes how to do for adolescent AQoL-6D health utility.
Using modules from the specific R package, it is possible to undertake an exploratory utility mapping analysis. This tutorial illustrates a hypotehtical example of exploring how to map to EQ-5D health utility.
Using modules from the TTU R package, it is possible to implement a fully reproducible utility mapping study. This tutorial illustrates the main steps using a hypothetical AQoL-6D utility mapping study.
Using tools (soon to be formalised into ready4 modules) from the youthu R package, it is possible to find and deploy relevant utility mapping algorithms. This tutorial illustrates the main steps for predicting AQoL-6D utility from psychological and functional measures collected on clinical samples of young people.
We used functions (soon to be formalised into ready4 modules) from the mychoice R package to design to a discrete choice experiment.
Using tools (soon to be formalised into ready4 framework modules) from the youthu R package, it is possible to use utility mapping algorithms to help implement cost-utility analyses. This tutorial illustrates the main steps for doing so using psychological and functional measures collected on clinical samples of young people.
Using tools (soon to be formalised into ready4 framework modules) from the mychoice R package, it is possible to develop choice models from responses to a discrete choice experiment survey.
Using functions (soon to be formalised into ready4 framework modules) from the mychoice R package, it is possible to develop choice models from responses to a discrete choice experiment survey.
We previously developed a user interface for the epidemiology modules of our Springtides model of places.
Using modules from the TTU, youthvars, scorz and specific libraries, we developed utility mapping algorithms from a sample of young people attending primary mental health care services.
Using functions (soon to be formalised into ready4 framework modules) from the youthu R package, we predicted health utility for a synthetic population of young people attending primary mental health care services.
What you need in order to be able to use ready4 software on your machine.
ready4 software is freely available from multiple open access repositories.
Whether and how you should use a specific version of ready4 software depends in part on its release status.
Code libraries are used to distribute software for applying our framework and implementing computational model modules.
ready4 libraries include tools for applying a modelling framework and for implementing computational models.
Executables (programs and sub-routines) are used to apply computational models to data and to report the resulting analyses.
User interfaces make it easier for non-technical users to explore and use ready4 models.
Each ready4 code library is supported by a standardised set of documentation resources.
ready4 is distributed without warranties under open source licenses - we just ask you to appropriately cite it.
Search for ready4 library and function dependencies using our interactive app.
ready4 is freely available to all under copy-left licensing arrangements.
If you find ready4 useful, please cite it appropriately - it is easy to do!
ready4 is distributed without any warranties.
Important information to review before installing and using our software
A subroutine for generating catalogues of utility mapping models created with the TTU library.
A template subroutine for generating a scientific manuscript for use with the ready4show library.
A subroutine for generating a scientific manuscript of a longitudinal utility mapping study undertaken with the TTU library.
A subroutine for a summary of the main results from a Discrete Choice Experiment implemented with the mychoice library.
Some work in progress code has yet to be publicly released or fornmally acknowledged as part of the ready4 suite.
Development releases provide the most comprehensive and up to date public record of a ready4 project’s source code but may be poorly documented and tested.
Production releases are the versions of software intended for end-users.
Archived releases are permanent, uniquely identified records of key project milestones.
There are two types of framework libraries - a foundational library and libraries of authoring tools.
There are three types of model module libraries - those for describing input data, developing models and making predictions.
Applying Spring To Life model modules to map psychological and functional measures to AQoL-6D health utility
Initial set of academic posters relating to the development of the readyforwhatsnext model.