Skip to content

Commit 083fd52

Browse files
authored
Add LLM-readiness documentation (#1)
1 parent 0b6d10b commit 083fd52

3 files changed

Lines changed: 95 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# AGENTS
2+
3+
## Project Purpose
4+
Central sleep apnea data analysis at U of U sleep-wake center
5+
6+
## Public and Data-Safety Rules
7+
- Treat this repository as public. Do not add PHI, restricted datasets, credentials, private drafts, or publisher-formatted article text.
8+
- Clinical sleep-center data likely restricted; verify no PHI
9+
- Manuscript status: Superseded or overlaps with CSA-CPAP-Prescribing; accepted draft candidates exist locally
10+
11+
## How to Orient Quickly
12+
- Start with `README.md` for project scope, workflow, data notes, citation, and license information.
13+
- Use `CITATION.cff` for structured citation metadata when present.
14+
- Inspect scripts/notebooks before running them; do not assume generated outputs are current.
15+
16+
## Workflow
17+
From the repository root, use this as the initial run guidance:
18+
19+
```bash
20+
Review Python workflow
21+
```
22+
23+
If the command is a placeholder, refine it after reading the local scripts and existing README.
24+
25+
## Verification Before Publishing Changes
26+
- Run `git diff --check`.
27+
- Validate `CITATION.cff` as YAML after citation edits.
28+
- Do not commit generated outputs, logs, caches, virtual environments, `.DS_Store`, or checkpoint files unless intentionally released.
29+
- For clinical or collaborator data, confirm that no row-level restricted data or identifiers are included.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Brian W. Locke
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Central Sleep Apnea Data Analysis
2+
3+
Central sleep apnea data analysis at U of U sleep-wake center
4+
5+
## LLM and Repository Readiness Notes
6+
7+
### Description
8+
Central sleep apnea data analysis at U of U sleep-wake center
9+
10+
### Instructions
11+
Start with this README, then inspect the files listed under Repository Layout. For computational workflows, run commands from the repository root and avoid committing generated outputs unless a release explicitly calls for them.
12+
13+
### Authors, Funding, and Acknowledgments
14+
Maintainer: Brian W. Locke (`@reblocke`, ORCID 0000-0002-3588-5238). Preserve any project-specific author, funding, and acknowledgment details already listed elsewhere in the repository or accompanying publication.
15+
16+
### Repository Layout
17+
- `DataAnalysis.py`
18+
- `Diag Test by Etiology.png`
19+
- `Diag Test by percentage CSA.png`
20+
- `Display Dist Age.png`
21+
- `Etio by percentage CSA no pie no label.png`
22+
- `Etio by percentage CSA no pie no tick labels.png`
23+
- `Etio by percentage CSA no pie.png`
24+
- `Etio by percentage CSA.png`
25+
26+
### Data and Codebook
27+
Clinical sleep-center data likely restricted; verify no PHI
28+
29+
### Workflow / Script Order
30+
Review Python workflow
31+
32+
### Dependencies / Environment
33+
Repo scripts
34+
35+
### Citation
36+
No publication DOI is assigned to this repository. Cite the GitHub repository URL and the commit or release used.
37+
38+
### License
39+
MIT License for repository code; see `LICENSE`. Third-party data, publisher text, and restricted clinical data are excluded.
40+
41+
### Manuscript Status
42+
Superseded or overlaps with CSA-CPAP-Prescribing; accepted draft candidates exist locally Do not add manuscript text until repo relationship and publisher policy are checked
43+
44+
### Contact
45+
Maintainer: Brian W. Locke (`@reblocke`). Use GitHub issues or pull requests for repository-specific questions when the repository is public.

0 commit comments

Comments
 (0)