-
Notifications
You must be signed in to change notification settings - Fork 1
Updated documentation for current features #151
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,22 +1,18 @@ | ||||||
| [](https://opensource.org/licenses/MIT) | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| # SoA Workbench | ||||||
|
|
||||||
| This workspace provides a Python package `soa_builder` with APIs to: | ||||||
|
|
||||||
| 1. Normalize a wide Schedule of Activities (SoA) matrix into relational tables. | ||||||
| 2. Expand repeating schedule rules into projected calendar instances. | ||||||
| This workspace provides a Python package `soa_builder` with APIs to create a Schedule of Activites for Clinical Studies. | ||||||
|
|
||||||
|
|
||||||
| ## Installation | ||||||
| Recommended: editable install for development. | ||||||
| ```bash | ||||||
| python3 -m venv .venv | ||||||
| source .venv/bin/activate | ||||||
| pip install -e . | ||||||
| pip install -r requirements.txt | ||||||
| pre-commit install | ||||||
| pre-commit run --all-files | ||||||
| ``` | ||||||
|
Comment on lines
9
to
16
|
||||||
|
|
||||||
| ## Start web server | ||||||
|
|
@@ -30,13 +26,15 @@ uvicorn soa_builder.web.app:app --reload --port 8000 | |||||
| ``` | ||||||
| HTML UI: | ||||||
| - Open http://localhost:8000/ in a browser. | ||||||
| - Add visits and activities; click cells to toggle status (blank -> X -> blank). 'O' values are not surfaced in the UI; clearing removes the cell row. | ||||||
| - Use "Generate Normalized Summary" link to produce artifacts. | ||||||
| - Use export buttons (to be added) or hit endpoints directly for XLSX output. | ||||||
| - Delete a visit or activity using the ✕ button next to its name (confirmation dialog). Deletion cascades to associated cells and automatically reorders remaining items. | ||||||
| - View biomedical concepts via the "Concepts" navigation link (`GET /ui/concepts`): renders a table of concept codes, titles and API links (cached; force refresh per study using `POST /ui/soa/{id}/concepts_refresh`). | ||||||
|
|
||||||
| Biomedical Concepts API Access: | ||||||
| - Create a new Schedule of Activities for a study or access an existing one. | ||||||
| - When a study is chosen, additional navigation links are available in the navigation menu that are unique to the Study context. | ||||||
| - More options and parameters for configuring the USDM classes are available through these navigation links. | ||||||
| - Add Scheduled Activity instances (columns) and activities (rows) to create an SoA matrix on the edit page for a Study; click cells to toggle status (blank -> X -> blank). 'O' values are not surfaced in the UI; clearing removes the cell row. | ||||||
|
Comment on lines
+29
to
+32
|
||||||
| - Use export buttons (to be added) for XLSX output of the Matrix. | ||||||
| - View avialable biomedical concepts via the "Biomedical Concepts" navigation link to render a table of concept codes, titles and API links (cached; force refresh available). | ||||||
|
||||||
| - View avialable biomedical concepts via the "Biomedical Concepts" navigation link to render a table of concept codes, titles and API links (cached; force refresh available). | |
| - View available biomedical concepts via the "Biomedical Concepts" navigation link to render a table of concept codes, titles and API links (cached; force refresh available). |
Copilot
AI
Mar 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This list item has inconsistent indentation (extra leading space before -), which can break Markdown list rendering. Align indentation with the surrounding bullets.
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -2,39 +2,95 @@ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| {% block content %} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| <h2>Steps to Create an SoA Matrix</h2> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| <ol> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| <li> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| <h3>Create a Schedule Timeline (container)</h3> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| <h3>Create a new Schedule of Activties on the landing page.</h3> | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| <h3>Create a new Schedule of Activties on the landing page.</h3> | |
| <h3>Create a new Schedule of Activities on the landing page.</h3> |
Copilot
AI
Mar 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: "landing lage" should be "landing page".
| A basic Schedule of Activity Matrix can be created on the landing lage once a study is created. | |
| A basic Schedule of Activity Matrix can be created on the landing page once a study is created. |
Copilot
AI
Mar 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: "coluuns" should be "columns".
| <li>Add Scheduled Instances to create coluuns for the SOA Matrix</li> | |
| <li>Add Scheduled Instances to create columns for the SOA Matrix</li> |
Copilot
AI
Mar 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: "Activites" should be "Activities".
Copilot
AI
Mar 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The text says "There are four configurations available" but the list below contains five items (Schedule Timelines, Scheduled Activity Instances, Scheduled Decision Instances, Condition Assignments, Timings). Update the count or adjust the list so they match.
Copilot
AI
Mar 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wording duplication: "menu navigation menu" should be simplified (e.g., just "navigation menu").
| <li>Click <strong>Transition Rules</strong> in the menu navigation menu</li> | |
| </ul> | |
| </li> | |
| <li> | |
| <h3>USDM JSON can also be generated</h3> | |
| <ul> | |
| <li>Click <strong>Generate USDM JSON</strong> in the menu navigation menu</li> | |
| <li>Click <strong>Transition Rules</strong> in the navigation menu</li> | |
| </ul> | |
| </li> | |
| <li> | |
| <h3>USDM JSON can also be generated</h3> | |
| <ul> | |
| <li>Click <strong>Generate USDM JSON</strong> in the navigation menu</li> |
Copilot
AI
Mar 6, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wording duplication: "menu navigation menu" should be simplified (e.g., just "navigation menu").
| <li>Click <strong>Transition Rules</strong> in the menu navigation menu</li> | |
| </ul> | |
| </li> | |
| <li> | |
| <h3>USDM JSON can also be generated</h3> | |
| <ul> | |
| <li>Click <strong>Generate USDM JSON</strong> in the menu navigation menu</li> | |
| <li>Click <strong>Transition Rules</strong> in the navigation menu</li> | |
| </ul> | |
| </li> | |
| <li> | |
| <h3>USDM JSON can also be generated</h3> | |
| <ul> | |
| <li>Click <strong>Generate USDM JSON</strong> in the navigation menu</li> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: "Activites" should be "Activities".