Version v0.0 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.
Priority 3: Apply ready4 to undertake replications and transfers
Categories:
Why?
In this relatively early stage of ready4’s development, the authoring of new ready4 modules can involve a significant investment of time and skills, an investment that is typically made in the context of implementing a modelling project for a scientific study. However, once authored, these modules may significantly streamline the implementation of modelling analyses that replicate or transfer the studies for which they were developed. For modellers and other researchers, using ready4 for this purpose may provide the highest reward to effort ratio of any contribution to the ready4 community. Network effects also kick in - more replications and generalisations mean more open access data and module customisations available to other users, enhancing the practical utility of ready4.
What?
We plan to demonstrate that studies implemented with ready4 are relatively straightforward and efficient to replicate and transfer. The most important initial types of help we need with achieving this goal are funding, projects, code contributions and advice.
How?
The main tasks for implementing study replications and transfers are:
-
Identify the example study to be replicated or transferred.
-
Review that study’s analysis program:
- do the data used in this program have similar structure / concepts / sampling to the data for which a new analysis is planned?
- are modules used in that program from production release module libraries and do any of them require authoring of inheriting modules to selectively update aspects of module data-structures or algorithms?
-
Create a new input dataset, labelling and (for non-confidential data) storing the data in an online repository (which can be kept private for now).
-
(If new inheriting modules are required) Make a code contribution to create and test new inheriting modules.
-
Adapt the original study’s analysis program to account for differences in input data, model modules and study reporting.
-
Share new new analysis program in the ready4 Zenodo community.
-
Ensure the online model input dataset is made public and submit it as a Linked Dataverse Dataset in the appropriate section of the ready Dataverse.
When?
In most cases, we recommend waiting until production releases of relevant module libraries are available. However, we are currently planning or actively undertaking some initial study analysis transfers using the development versions of our utility mapping and choice modelling module libraries. We are undertaking this work in parallel with testing and, where necessary, extending the required modules. We suggest that, should you believe that any of our development version software is potentially relevant to a study you wish to undertake, you first get in touch with our project lead to discuss the pros / cons and timing of using this software.