Framework library releases
Releases of foundation and authoring tools libraries to implement the ready4 framework.
Tag: Software - libraries
Installing the ready4 framework foundation library
The ready4 framework foundation is the first ready4 library you should install.
Categories:
Installing tools for authoring computational models
Instructions for installing the ready4class, ready4fun and ready4pack libraries.
Categories:
Installing tools for authoring and managing model datasets
Instructions for installing the ready4use library.
Categories:
Installing authoring tools
Depending on how you plan to use ready4, you may need to install some or all of its authoring tools.
Categories:
Create a synthetic population of young people attending primary mental health services
We created a basic synthetic dataset of to represent a clinical youth mental health sample.
Categories:
People module library releases
Releases of module libraries for modelling people (collectively, the Spring To Life model).
Categories:
Places module library releases
Releases of module libraries for modelling places (collectively, the Springtides model).
Categories:
Installing tools for authoring reproducible analyses
Instructions for installing the ready4show library.
Categories:
Installing ready4 computational model modules
To implement a modelling analysis with ready4 you need to install computational model modules.
Categories:
Library releases
Categories:
Releases of module libraries
Categories:
Why ready4 is object oriented
ready4 uses an object oriented programming (OOP) paradigm to implement computational models.
Categories:
Authoring model data structures
The ready4class R package supports partially automated and standardised workflows for defining the data structures to be used in computational models.
Categories:
Modularity
ready4 supports a modular approach to computational model development.
Categories:
The role of functional programming in ready4 development
ready4 uses functional programming to maximise the re-usability of model algorithms.
Categories:
Syntax
ready4 modules use a simple and consistent syntax.
Categories:
Authoring model algorithms
The ready4fun R package supports standardised approaches to code authoring that facilitate partial automation of the documenting of model algorithms.
Categories:
Dissemating citable, documented and quality assured model module libraries
ready4 supports tools to streamline the testing, description and distribution of computational model modules.
Categories:
Ingest, label and share model data
The ready4use R package provides tools for supplying data to youth mental health computational models.
Categories:
Ingest data from an open access repository
A tutorial from the Acumen website about using ready4 to search and retrieve data from the Australian Mental Health Systems Models Dataverse.
Categories:
Search open access data collections
Online open access data repositories are the preferred storage locations for ready4 model datasets.
Categories:
Add metadata to datasets of individual human records
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.
Categories:
Add a data dictionary to a dataset
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.
Categories:
Authoring scientific manuscripts
Tools from the ready4show R package support authoring of scientific summaries of analyses with ready4.
Categories:
Validate variable total scores
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.
Categories:
Author and share reproducible analyses
Tools from the ready4show R package support authoring of programs and subroutines to implement and report analyses with ready4.
Categories:
Score health utility
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.
Categories:
Share data via online repositories
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.
Categories:
Explore candidate utility mapping models
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.
Categories:
Implement a utility mapping study
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.
Categories:
Find and deploy utility mapping models
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.
Categories:
Design a Discrete Choice Experiment
We used functions (soon to be formalised into ready4 modules) from the mychoice R package to design to a discrete choice experiment.
Categories:
Develop choice models
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.
Categories:
Use utility mapping algorithms to help implement cost-utility analyses
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.
Categories:
Analyse the results of a Discrete Choice Experiment
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.
Categories:
Develop health utility mapping algorithms
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.
Categories:
Predict health utility
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.
Categories:
Code libraries
Code libraries are used to distribute our software framework and modules of our computational model.
Categories:
Current libraries
ready4 libraries include tools for applying a modelling framework and for implementing computational models.
Categories:
Code library documentation
Each ready4 code library is supported by a standardised set of documentation resources.
Categories:
Dependencies
Search for ready4 library and function dependencies using our interactive app.
Categories:
Installation and set-up
Important information to review before installing and using our software
Categories:
Make a catalogue of utility mapping models
A subroutine for generating catalogues of utility mapping models created with the TTU library.
Categories:
Author a template scientific manuscript
A template subroutine for generating a scientific manuscript for use with the ready4show library.
Categories:
Author a draft scientific manuscript for a utility mapping study
A subroutine for generating a scientific manuscript of a longitudinal utility mapping study undertaken with the TTU library.
Categories:
Make results summary for a Discrete Choice Experiment
A subroutine for a summary of the main results from a Discrete Choice Experiment implemented with the mychoice library.
Categories:
Framework libraries
There are two types of framework libraries - a foundational library and libraries of authoring tools.
Categories:
Model module libraries
There are three types of model module libraries - those for describing input data, developing models and making predictions.
Categories:
Predicting Quality Adjusted Life Years in young people attending primary mental health services
Applying Spring To Life model modules to map psychological and functional measures to AQoL-6D health utility