Skip to content

Commit

Permalink
more doc work..
Browse files Browse the repository at this point in the history
  • Loading branch information
Miller committed Oct 16, 2023
1 parent 84cb1a1 commit 22f7520
Show file tree
Hide file tree
Showing 12 changed files with 271 additions and 56 deletions.
18 changes: 13 additions & 5 deletions docs/development.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -427,8 +427,18 @@ <h1 class="title toc-ignore"><img src="images/ohdsi40x40.png"></img>

<div id="overview" class="section level1">
<h1><strong>Overview</strong></h1>
<p>TODO: Description of maturity sprint</p>
<hr />
<div id="approach" class="section level2">
<h2>Approach</h2>
<ul>
<li>Estabishing “standard conventions”
<ul>
<li>Adequately documented</li>
<li>Singular representation in OMOP</li>
<li>Favoring extensible over ad hoc solutions</li>
</ul></li>
</ul>
</div>
<div id="goals" class="section level2">
<h2>Goals</h2>
<ul>
Expand Down Expand Up @@ -468,6 +478,8 @@ <h2>Scope / Timeline</h2>
<div id="core-values" class="section level2">
<h2>Core Values</h2>
<ul>
<li>Enabling studies as determining factor for prioritization of
effort</li>
<li>Inclusion of as diverse of data as possible
<ul>
<li>International applicability</li>
Expand Down Expand Up @@ -500,7 +512,6 @@ <h2>What we need</h2>
</div>
<div id="project-management" class="section level1">
<h1><strong>Project Management</strong></h1>
<p>(TODO): bullet summary points</p>
<div id="collaborative-approach" class="section level2">
<h2>Collaborative approach</h2>
<ul>
Expand All @@ -516,9 +527,6 @@ <h2>Collaborative approach</h2>
environment</li>
</ul>
</div>
<div id="meetings" class="section level2">
<h2>Meetings</h2>
</div>
<div id="github-project" class="section level2">
<h2>Github Project</h2>
<ul>
Expand Down
58 changes: 42 additions & 16 deletions docs/githubProject.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -425,36 +425,62 @@ <h1 class="title toc-ignore"><img src="images/ohdsi40x40.png"></img>
</div>


<hr />
<div id="approach" class="section level1">
<h1><strong>Approach</strong></h1>
<p>TODO: bullet summary points e.g. breaking up into small pieces;
everything ends with documentation; linear development cycle; evolving
scope, etc.</p>
<hr />
<div id="overview" class="section level1">
<h1><strong>Overview</strong></h1>
<p><br></p>
<div id="architecture" class="section level2">
<h2>Architecture</h2>
<h2><strong>Architecture</strong></h2>
<ul>
<li>(TODO) Explanation of project vs. github repo</li>
<li>(TODO) Navigation of project vs. Github issues</li>
<li>(TODO) End deliverables will be: building concept and
concept_relationship tables; documentation/conventions; deployment
tool</li>
<li>While most of the relevant “issues” exist within the
OHDSI/OncologyWG repository, the project itself lives at the
organization (OHDSI) level: <a
href="https://github.com/orgs/OHDSI/projects/13"
class="uri">https://github.com/orgs/OHDSI/projects/13</a></li>
<li>You can navigate the issues through the repository if you wish but
it is much more organized and intuitive to leverage the “Views” within
the project (see: Project Views below)</li>
</ul>
<hr />
</div>
<div id="strategy" class="section level2">
<h2><strong>Strategy</strong></h2>
<ul>
<li>Leverage community feedback to establish dynamic inventory of
maturity tasks</li>
<li>Break down the problems into granular tasks</li>
<li>Follow a linear development cycle (see below) that always ends in
validation and documentation</li>
<li>Enable asynchronous development and contributions independent of
whether able to attend meetings</li>
<li>Prioritize work based on use cases but allow contributors to focus
on what content applies to them</li>
<li>Enable contributions from all levels of technical experience</li>
<li>The end deliverables for each convention include:
<ul>
<li>Documentation within the Github.io page</li>
<li>Additions to delta “concept” and “concept_relationship” tables (see:
<a
href="https://github.com/OHDSI/OncologyWG/tree/master/deltaVocab#ohdsi-oncology-workgroup-deltavocab">delta
vocab readme</a>)</li>
</ul></li>
</ul>
<hr />
</div>
<div id="project-views" class="section level2">
<h2>Project Views</h2>
<h2><strong>Project Views</strong></h2>
<ul>
<li>(TODO) 1) illustrate the intention of each view</li>
<li>(TODO) 2) show can one can contribute to specific task types by
navigating views If you’d like to contribute to a specific Task Group,
add yourself as an assignee and change the status from Outstanding to In
Progress</li>
</ul>
<hr />
<p><br></p>
</div>
</div>
<div id="example-vertical-sprint-walkthrough" class="section level1">
<h1><strong>Example vertical sprint walkthrough</strong></h1>
<div id="example-walkthrough" class="section level1">
<h1><strong>Example walkthrough</strong></h1>
<ul>
<li>Top level: Task groups</li>
</ul>
Expand Down
118 changes: 110 additions & 8 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -483,20 +483,122 @@ <h2><strong>Subgroups &amp; Meeting Schedule</strong></h2>
</div>
<div id="site-map" class="section level2">
<h2><strong>Site Map</strong></h2>
<p><strong>(TODO: Redo )</strong></p>
<p>This site contains the following sections:</p>
<p><br></p>
<p><strong><a href="background.html">Background</a></strong></p>
<table>
<colgroup>
<col width="35%" />
<col width="64%" />
<col width="40%" />
<col width="60%" />
</colgroup>
<thead>
<tr class="header">
<th align="left">Section</th>
<th align="left">Content</th>
<tbody>
<tr class="odd">
<td><a href="background.html#Problem_Space">Problem Space</a></td>
<td align="left">High level summary of working group mission</td>
</tr>
</thead>
<tr class="even">
<td><a href="background.html#Goals">Goals</a></td>
<td align="left">Goals of working group</td>
</tr>
<tr class="odd">
<td><a href="background.html#Challenges">Challenges</a></td>
<td align="left">Core challenges of effort</td>
</tr>
<tr class="even">
<td><a
href="background.html#PublicationsPresentation">Publications/Presentations</a></td>
<td align="left">Links to some relevant publications &amp;
presentations</td>
</tr>
</tbody>
</table>
<p><strong>Development Effort</strong></p>
<table>
<colgroup>
<col width="40%" />
<col width="60%" />
</colgroup>
<tbody>
<tr class="odd">
<td><strong><a href="development.html">Development
Overview</a></strong></td>
<td align="left">Overview of current development effort</td>
</tr>
<tr class="even">
<td><a href="development.html#Project_Management">Project
Management</a></td>
<td align="left">Overview of current development effort</td>
</tr>
<tr class="odd">
<td><strong><a href="progressMap.html">Progress</a></strong></td>
<td align="left"></td>
</tr>
<tr class="even">
<td><a href="progressMap.html#Prioritization">Prioritization</a></td>
<td align="left">Overview of current development effort</td>
</tr>
<tr class="odd">
<td><a href="progressMap.html#Miro_Map">Miro Map</a></td>
<td align="left">Overview of current development effort</td>
</tr>
<tr class="even">
<td><a href="progressMap.html#Roadmap">Roadmap</a></td>
<td align="left">Overview of current development effort</td>
</tr>
<tr class="odd">
<td><strong><a href="githubProject.html">Github Project
Orientation</a></strong></td>
<td align="left"></td>
</tr>
<tr class="even">
<td><a href="githubProject.html#Approach">Approach</a></td>
<td align="left">Overview of current development effort</td>
</tr>
<tr class="odd">
<td><a href="githubProject.html#Architecture">Architecture</a></td>
<td align="left">Overview of current development effort</td>
</tr>
<tr class="even">
<td><a href="githubProject.html#Project_Views">Project Views</a></td>
<td align="left">Overview of current development effort</td>
</tr>
<tr class="odd">
<td><a href="githubProject.html#Approach">Example Walkthrough</a></td>
<td align="left">Overview of current development effort</td>
</tr>
<tr class="even">
<td><strong><a href="gettingInvolved.html">Getting
Involved</a></strong></td>
<td align="left"></td>
</tr>
<tr class="odd">
<td><a
href="gettingInvolved.html#join_collaboration_channels">Collaboration
Channels</a></td>
<td align="left">Overview of current development effort</td>
</tr>
<tr class="even">
<td><a href="gettingInvolved.html#Review_Project_Documentation">Review
Project Documentation</a></td>
<td align="left">Overview of current development effort</td>
</tr>
</tbody>
</table>
<p><strong><a href="conventions.html">Conventions</a></strong></p>
<table>
<colgroup>
<col width="40%" />
<col width="60%" />
</colgroup>
<tbody>
<tr class="odd">
<td><a href="conventions.html#Diagnostic">Diagnostic</a></td>
<td align="left">Overview of current development effort</td>
</tr>
<tr class="even">
<td><a href="conventions.html#Treatment">Treatment</a></td>
<td align="left">Overview of current development effort</td>
</tr>
</tbody>
</table>
</div>
Expand Down
4 changes: 4 additions & 0 deletions docs/model.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,10 @@ <h1 class="title toc-ignore"><img src="images/ohdsi40x40.png"></img>Oncology


<p><br></p>
<blockquote>
<p><svg aria-hidden="true" role="img" viewBox="0 0 512 512" style="height:1em;width:1em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:orange;overflow:visible;position:relative;"><path d="M256 32c14.2 0 27.3 7.5 34.5 19.8l216 368c7.3 12.4 7.3 27.7 .2 40.1S486.3 480 472 480H40c-14.3 0-27.6-7.7-34.7-20.1s-7-27.8 .2-40.1l216-368C228.7 39.5 241.8 32 256 32zm0 128c-13.3 0-24 10.7-24 24V296c0 13.3 10.7 24 24 24s24-10.7 24-24V184c0-13.3-10.7-24-24-24zm32 224a32 32 0 1 0 -64 0 32 32 0 1 0 64 0z"/></svg>
Under Construction</p>
</blockquote>
<div id="representation" class="section level2">
<h2><strong>Representation</strong></h2>
<p><br></p>
Expand Down
8 changes: 4 additions & 4 deletions docs/progressMap.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -427,16 +427,16 @@ <h1 class="title toc-ignore"><img src="images/ohdsi40x40.png"></img>

<p><br></p>
<hr />
<div id="prioritization" class="section level1">
<h1><strong>Prioritization</strong></h1>
<p>(TODO)</p>
</div>
<div id="miro-map" class="section level1">
<h1><strong>Miro Map</strong></h1>
<iframe width="768" height="432" src="https://miro.com/app/live-embed/uXjVNeNGMhQ=/?moveToViewport=7473,-157,1086,1135&amp;embedId=264604379153" frameborder="0" scrolling="no" allow="fullscreen; clipboard-read; clipboard-write" allowfullscreen>
</iframe>
<p>TODO: Explanation of intent and links</p>
</div>
<div id="prioritization" class="section level1">
<h1><strong>Prioritization</strong></h1>
<p>(TODO)</p>
</div>
<div id="roadmap" class="section level1">
<h1><strong>Roadmap</strong></h1>
<p>Our goal is to create an interoperable OMOP extension that enables
Expand Down
4 changes: 4 additions & 0 deletions docs/tooling.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,10 @@ <h1 class="title toc-ignore"><img src="images/ohdsi40x40.png"></img>


<p><br></p>
<blockquote>
<p><svg aria-hidden="true" role="img" viewBox="0 0 512 512" style="height:1em;width:1em;vertical-align:-0.125em;margin-left:auto;margin-right:auto;font-size:inherit;fill:orange;overflow:visible;position:relative;"><path d="M256 32c14.2 0 27.3 7.5 34.5 19.8l216 368c7.3 12.4 7.3 27.7 .2 40.1S486.3 480 472 480H40c-14.3 0-27.6-7.7-34.7-20.1s-7-27.8 .2-40.1l216-368C228.7 39.5 241.8 32 256 32zm0 128c-13.3 0-24 10.7-24 24V296c0 13.3 10.7 24 24 24s24-10.7 24-24V184c0-13.3-10.7-24-24-24zm32 224a32 32 0 1 0 -64 0 32 32 0 1 0 64 0z"/></svg>
Under Construction</p>
</blockquote>
<div id="applications" class="section level1">
<h1><strong>Applications</strong></h1>
<p><em>TODO: Brief overview </em></p>
Expand Down
15 changes: 9 additions & 6 deletions rmd/development.rmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,16 @@ output:

# **Overview**

TODO: Description of maturity sprint

---

## Approach

- Estabishing "standard conventions"
- Adequately documented
- Singular representation in OMOP
- Favoring extensible over ad hoc solutions

## Goals

- Collaboratively mature the oncology standards in OMOP
Expand All @@ -31,6 +37,8 @@ TODO: Description of maturity sprint

## Core Values


- Enabling studies as determining factor for prioritization of effort
- Inclusion of as diverse of data as possible
- International applicability
- Clinical, registry, and other specialized data sources
Expand All @@ -53,8 +61,6 @@ TODO: Description of maturity sprint

# **Project Management**

(TODO): bullet summary points



## Collaborative approach
Expand All @@ -65,9 +71,6 @@ TODO: Description of maturity sprint
- Discussions around items will be held off-line within MS Teams environment


## Meetings




## Github Project
Expand Down
Loading

0 comments on commit 22f7520

Please sign in to comment.