[Paper or working title]

On this page

Template for an OSRI research project. Replace the prompts and remove unused sections. Name the repository after the paper or working title, using lowercase words separated by hyphens. Start with the brief; add methods and execution details as the work develops.

Project brief#

  • Project ID: [Assigned stable ID, for example OSRI-0001]
  • Human lead: [Name or GitHub handle]
  • Research areas: [One or more OSRI areas]
  • Area scope: [Link to area definitions. Initial Healthcare work is nonclinical. Raise a proposed expansion with the human lead.]
  • Current state: [What has been proposed, done, checked, and shared]
  • Question or contribution: [What do we want to understand or contribute?]
  • Scope: [What this project will investigate and the relevant limits]
  • Shared standards: [Version and link to OSRI contribution standards]
  • Selected tools and skills: [Source, version or commit, applicable workflow, required inputs and outputs, and checks. Manual or equivalent tools may meet the same requirements.]

Take part#

[Link to the lead issue and available tasks. Include a route for questions, source suggestions, writing, or review. State subject knowledge and tooling needs separately. Explain how someone unfamiliar with Git can participate.] The OSRI Discussions forum is one route.

Research approach#

[Link to the method or protocol when needed. Record exploration as exploration. Identify the plan fixed before a planned test. Date and explain later changes. State assumptions and how results will be assessed.]

Evidence and data#

[Identify sources, data origins and versions, reuse terms, and access instructions. Link the resource catalog and administrator request route. Record access decisions without credentials or restricted material.]

Exchange formats#

[Preserve editable sources. Identify open exchange formats, units, identifiers, missing-value conventions, and any material conversion losses. Add conversion instructions when needed.]

Reproduce or inspect the work#

[For executable work: provide setup, exact commands, inputs, environment, and expected outputs. For other work: explain how to follow the source-to-conclusion record. State checks performed and limitations.]

Publications and contributions#

[Link to writing and public outputs. Record publication type, date, peer-review status, and the shared research-work ID. Credit contributors and describe material agent assistance.]

Reuse#

[State the selected licenses for original code and writing, plus the terms applying to reused data and other third-party material. Add citation metadata when ready.]

View source on GitHub