@pikaa-ai/pikaa 0.3.23 → 0.3.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/assets/brand/orbit-logo-option4-whale.jpg +0 -0
- package/assets/brand/orbit-logo.jpg +0 -0
- package/assets/brand/orbit-logo.png +0 -0
- package/assets/brand/orbit-logo.svg +3 -0
- package/dist/cli.js +407 -219
- package/dist/index.js +7 -2
- package/package.json +1 -2
- package/skills/adaptyv/SKILL.md +0 -240
- package/skills/aeon/SKILL.md +0 -402
- package/skills/analytical-method-validation/SKILL.md +0 -299
- package/skills/anndata/SKILL.md +0 -431
- package/skills/arbor/SKILL.md +0 -152
- package/skills/arboreto/SKILL.md +0 -267
- package/skills/astropy/SKILL.md +0 -353
- package/skills/autoskill/SKILL.md +0 -233
- package/skills/benchling-integration/SKILL.md +0 -229
- package/skills/bgpt-paper-search/SKILL.md +0 -75
- package/skills/bids/SKILL.md +0 -237
- package/skills/biopython/SKILL.md +0 -472
- package/skills/bioservices/SKILL.md +0 -399
- package/skills/bulk-rnaseq/SKILL.md +0 -198
- package/skills/cellxgene-census/SKILL.md +0 -283
- package/skills/cirq/SKILL.md +0 -370
- package/skills/citation-management/SKILL.md +0 -329
- package/skills/clinical-decision-support/SKILL.md +0 -238
- package/skills/clinical-decision-support/references/README.md +0 -62
- package/skills/clinical-reports/SKILL.md +0 -248
- package/skills/clinical-reports/references/README.md +0 -34
- package/skills/cobrapy/SKILL.md +0 -496
- package/skills/consciousness-council/SKILL.md +0 -151
- package/skills/dask/SKILL.md +0 -482
- package/skills/database-lookup/SKILL.md +0 -386
- package/skills/datamol/SKILL.md +0 -200
- package/skills/deepchem/SKILL.md +0 -244
- package/skills/deepspot-m/SKILL.md +0 -175
- package/skills/deeptools/SKILL.md +0 -412
- package/skills/depmap/SKILL.md +0 -301
- package/skills/dhdna-profiler/SKILL.md +0 -184
- package/skills/diffdock/SKILL.md +0 -488
- package/skills/dnanexus-integration/SKILL.md +0 -325
- package/skills/docx/SKILL.md +0 -99
- package/skills/esm/SKILL.md +0 -334
- package/skills/etetoolkit/SKILL.md +0 -327
- package/skills/exa-search/SKILL.md +0 -102
- package/skills/executing-plans/SKILL.md +0 -14
- package/skills/experimental-design/SKILL.md +0 -234
- package/skills/exploratory-data-analysis/SKILL.md +0 -280
- package/skills/flowio/SKILL.md +0 -310
- package/skills/fluidsim/SKILL.md +0 -279
- package/skills/frontend-design/SKILL.md +0 -100
- package/skills/generate-image/SKILL.md +0 -304
- package/skills/geniml/SKILL.md +0 -310
- package/skills/genomic-coordinates/SKILL.md +0 -189
- package/skills/genomic-intelligence/SKILL.md +0 -243
- package/skills/geomaster/README.md +0 -105
- package/skills/geomaster/SKILL.md +0 -366
- package/skills/geopandas/SKILL.md +0 -250
- package/skills/get-available-resources/SKILL.md +0 -260
- package/skills/gget/SKILL.md +0 -153
- package/skills/ginkgo-cloud-lab/SKILL.md +0 -106
- package/skills/glycoengineering/SKILL.md +0 -339
- package/skills/gtars/SKILL.md +0 -282
- package/skills/guardian-rails/SKILL.md +0 -54
- package/skills/histolab/SKILL.md +0 -243
- package/skills/hugging-science/SKILL.md +0 -132
- package/skills/hypogenic/SKILL.md +0 -290
- package/skills/hypothesis-generation/SKILL.md +0 -264
- package/skills/imaging-data-commons/SKILL.md +0 -496
- package/skills/infographics/SKILL.md +0 -315
- package/skills/iso-standards-readiness/SKILL.md +0 -352
- package/skills/lab-hardware-cad/SKILL.md +0 -372
- package/skills/labarchive-integration/SKILL.md +0 -216
- package/skills/lamindb/SKILL.md +0 -408
- package/skills/latchbio-integration/SKILL.md +0 -227
- package/skills/latex-posters/SKILL.md +0 -369
- package/skills/latex-posters/references/README.md +0 -439
- package/skills/liteparse/SKILL.md +0 -295
- package/skills/literature-review/SKILL.md +0 -263
- package/skills/markdown-mermaid-writing/SKILL.md +0 -322
- package/skills/market-research-reports/SKILL.md +0 -337
- package/skills/markitdown/SKILL.md +0 -264
- package/skills/matchms/SKILL.md +0 -276
- package/skills/matlab/SKILL.md +0 -274
- package/skills/matplotlib/SKILL.md +0 -378
- package/skills/medchem/SKILL.md +0 -321
- package/skills/modal/SKILL.md +0 -468
- package/skills/molecular-dynamics/SKILL.md +0 -458
- package/skills/molfeat/SKILL.md +0 -348
- package/skills/ncats-arax/SKILL.md +0 -178
- package/skills/networkx/SKILL.md +0 -440
- package/skills/neurokit2/SKILL.md +0 -323
- package/skills/neuropixels-analysis/SKILL.md +0 -412
- package/skills/nextflow/SKILL.md +0 -195
- package/skills/omero-integration/SKILL.md +0 -222
- package/skills/onekgpd/SKILL.md +0 -371
- package/skills/ontology-term-resolution/SKILL.md +0 -147
- package/skills/open-notebook/SKILL.md +0 -297
- package/skills/openpiv/SKILL.md +0 -469
- package/skills/opentrons-integration/SKILL.md +0 -322
- package/skills/optimize-for-gpu/SKILL.md +0 -176
- package/skills/owasp-top10/SKILL.md +0 -48
- package/skills/pacsomatic/LICENSE +0 -21
- package/skills/pacsomatic/SKILL.md +0 -150
- package/skills/paper-lookup/SKILL.md +0 -263
- package/skills/paperclip/SKILL.md +0 -413
- package/skills/paperzilla/SKILL.md +0 -159
- package/skills/parallel-web/SKILL.md +0 -128
- package/skills/pathml/SKILL.md +0 -222
- package/skills/pathogen-variant-surveillance/SKILL.md +0 -208
- package/skills/pathway-enrichment/SKILL.md +0 -194
- package/skills/pdf/SKILL.md +0 -322
- package/skills/peer-review/SKILL.md +0 -288
- package/skills/penetration-testing/SKILL.md +0 -31
- package/skills/pennylane/SKILL.md +0 -240
- package/skills/phylogenetics/SKILL.md +0 -409
- package/skills/pi-agent/SKILL.md +0 -83
- package/skills/pkpd-modeling/SKILL.md +0 -381
- package/skills/polars/SKILL.md +0 -393
- package/skills/polars-bio/SKILL.md +0 -379
- package/skills/ponytail/SKILL.md +0 -31
- package/skills/ponytail-audit/SKILL.md +0 -18
- package/skills/pptx/SKILL.md +0 -246
- package/skills/pptx-posters/SKILL.md +0 -258
- package/skills/primekg/SKILL.md +0 -99
- package/skills/protocolsio-integration/SKILL.md +0 -236
- package/skills/pufferlib/SKILL.md +0 -328
- package/skills/pydeseq2/SKILL.md +0 -369
- package/skills/pydicom/SKILL.md +0 -381
- package/skills/pyhealth/SKILL.md +0 -124
- package/skills/pylabrobot/SKILL.md +0 -216
- package/skills/pymatgen/SKILL.md +0 -404
- package/skills/pymc/SKILL.md +0 -310
- package/skills/pymoo/SKILL.md +0 -276
- package/skills/pyopenms/SKILL.md +0 -179
- package/skills/pysam/SKILL.md +0 -330
- package/skills/pytdc/SKILL.md +0 -297
- package/skills/pytorch-lightning/SKILL.md +0 -191
- package/skills/pyzotero/SKILL.md +0 -137
- package/skills/qiskit/SKILL.md +0 -259
- package/skills/qutip/SKILL.md +0 -317
- package/skills/rdkit/SKILL.md +0 -94
- package/skills/relsa-severity-assessment/SKILL.md +0 -354
- package/skills/research-grants/SKILL.md +0 -296
- package/skills/research-grants/references/README.md +0 -287
- package/skills/research-lookup/README.md +0 -106
- package/skills/research-lookup/SKILL.md +0 -338
- package/skills/rowan/SKILL.md +0 -398
- package/skills/scanpy/SKILL.md +0 -303
- package/skills/scholar-evaluation/SKILL.md +0 -296
- package/skills/scientific-brainstorming/SKILL.md +0 -282
- package/skills/scientific-critical-thinking/SKILL.md +0 -180
- package/skills/scientific-schematics/SKILL.md +0 -370
- package/skills/scientific-slides/SKILL.md +0 -379
- package/skills/scientific-visualization/SKILL.md +0 -285
- package/skills/scientific-writing/SKILL.md +0 -356
- package/skills/scikit-bio/SKILL.md +0 -470
- package/skills/scikit-learn/SKILL.md +0 -324
- package/skills/scikit-survival/SKILL.md +0 -313
- package/skills/scvelo/SKILL.md +0 -328
- package/skills/scvi-tools/SKILL.md +0 -201
- package/skills/seaborn/SKILL.md +0 -254
- package/skills/security-auditor/SKILL.md +0 -37
- package/skills/shap/SKILL.md +0 -282
- package/skills/simpy/SKILL.md +0 -283
- package/skills/stable-baselines3/SKILL.md +0 -325
- package/skills/statistical-analysis/SKILL.md +0 -446
- package/skills/statistical-power/SKILL.md +0 -200
- package/skills/statsmodels/SKILL.md +0 -238
- package/skills/sympy/SKILL.md +0 -354
- package/skills/systematic-debugging/SKILL.md +0 -35
- package/skills/tamarind/SKILL.md +0 -285
- package/skills/tdd/SKILL.md +0 -26
- package/skills/tiledbvcf/SKILL.md +0 -456
- package/skills/timesfm-forecasting/SKILL.md +0 -408
- package/skills/timesfm-forecasting/examples/global-temperature/README.md +0 -178
- package/skills/torch-geometric/SKILL.md +0 -458
- package/skills/torchdrug/SKILL.md +0 -241
- package/skills/transformers/SKILL.md +0 -195
- package/skills/treatment-plans/SKILL.md +0 -174
- package/skills/treatment-plans/references/README.md +0 -19
- package/skills/umap-learn/SKILL.md +0 -488
- package/skills/uncertainty-and-units/SKILL.md +0 -384
- package/skills/usfiscaldata/SKILL.md +0 -171
- package/skills/vaex/SKILL.md +0 -204
- package/skills/venue-templates/SKILL.md +0 -269
- package/skills/verification-before-completion/SKILL.md +0 -22
- package/skills/waypoint-bio/SKILL.md +0 -273
- package/skills/what-if-oracle/SKILL.md +0 -184
- package/skills/writing-plans/SKILL.md +0 -15
- package/skills/xlsx/SKILL.md +0 -110
- package/skills/zarr-python/SKILL.md +0 -241
|
@@ -1,356 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: scientific-writing
|
|
3
|
-
description: Draft, revise, and audit scientific manuscripts or reports with explicit evidence provenance, reporting-guideline coverage, authorship accountability, confidentiality controls, and local consistency checks. Use for manuscript sections, references, declarations, tables, figures, or submission preparation when scientific accuracy and traceability matter.
|
|
4
|
-
license: MIT
|
|
5
|
-
compatibility: Requires Python 3.11+ only for optional dependency-free local CLIs; core guidance is platform-neutral. Bundled tools are offline and require no API keys.
|
|
6
|
-
metadata:
|
|
7
|
-
version: "2.0"
|
|
8
|
-
skill-author: K-Dense Inc.
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
# Scientific Writing
|
|
12
|
-
|
|
13
|
-
## Purpose
|
|
14
|
-
|
|
15
|
-
Produce clear scientific prose without inventing evidence or concealing uncertainty.
|
|
16
|
-
Keep drafting, evidence verification, and submission approval as separate stages.
|
|
17
|
-
|
|
18
|
-
The accountable human authors control scientific decisions and final approval. AI is
|
|
19
|
-
not an author, and generated fluency is never evidence [SW-S01, SW-S03].
|
|
20
|
-
|
|
21
|
-
## Non-negotiable safety rules
|
|
22
|
-
|
|
23
|
-
### Confidentiality
|
|
24
|
-
|
|
25
|
-
Do not send unpublished manuscripts, peer-review or editorial material, sensitive or
|
|
26
|
-
restricted data, PHI or other personal data, proprietary content, or source documents
|
|
27
|
-
to an external service without:
|
|
28
|
-
|
|
29
|
-
1. explicit authorization from a person or body empowered to grant it; and
|
|
30
|
-
2. a documented review of journal, institutional, funder, consent, ethics, contractual,
|
|
31
|
-
legal, and data-use policy.
|
|
32
|
-
|
|
33
|
-
When authorization or policy is unclear, keep processing local and use only the minimum
|
|
34
|
-
metadata needed. De-identification requires expert review; removing obvious names is
|
|
35
|
-
not sufficient. See `references/authorship_ai_confidentiality.md`.
|
|
36
|
-
|
|
37
|
-
### No fabrication
|
|
38
|
-
|
|
39
|
-
Never invent or complete:
|
|
40
|
-
|
|
41
|
-
- citations, references, DOI, PMID, PMCID, ISBN, URLs, or quotations;
|
|
42
|
-
- results, data values, denominators, sample sizes, units, effect estimates,
|
|
43
|
-
uncertainty, statistical tests, or significance claims;
|
|
44
|
-
- methods, materials, protocol details, software versions, analysis choices, or
|
|
45
|
-
deviations;
|
|
46
|
-
- registrations, approvals, consent, ethics statements, participant details, or dates;
|
|
47
|
-
- authors, author order, CRediT roles, acknowledgments, or permissions;
|
|
48
|
-
- funding, sponsor roles, conflicts, data or code availability, or AI disclosures.
|
|
49
|
-
|
|
50
|
-
Use an explicit missing, unverified, or not-applicable state. Do not substitute plausible
|
|
51
|
-
boilerplate.
|
|
52
|
-
|
|
53
|
-
### Evidence binding
|
|
54
|
-
|
|
55
|
-
Every factual or numeric manuscript claim must map to verified evidence IDs. A human
|
|
56
|
-
verifier must open the source, confirm the proposition and locator, verify bibliographic
|
|
57
|
-
metadata, and record who verified it and when.
|
|
58
|
-
|
|
59
|
-
Search snippets, generated summaries, memory, and another work's bibliography may aid
|
|
60
|
-
discovery but do not verify a claim. See `references/evidence_workflow.md`.
|
|
61
|
-
|
|
62
|
-
### Scientific fidelity
|
|
63
|
-
|
|
64
|
-
- Preserve uncertainty and alternative explanations.
|
|
65
|
-
- Distinguish confirmatory, exploratory, descriptive, and post hoc work.
|
|
66
|
-
- Keep methods and results consistent.
|
|
67
|
-
- Reconcile units, denominators, sample sizes, populations, time points, and labels.
|
|
68
|
-
- Report negative, null, adverse, unexpected, failed, and inconclusive findings when
|
|
69
|
-
they belong to the study record.
|
|
70
|
-
- State concrete limitations and bound generalizability.
|
|
71
|
-
- Do not convert association into causation or non-significance into equivalence.
|
|
72
|
-
|
|
73
|
-
## Intake
|
|
74
|
-
|
|
75
|
-
Before drafting, obtain or mark unresolved:
|
|
76
|
-
|
|
77
|
-
- document type, study design, stage, audience, and target venue;
|
|
78
|
-
- current author instructions and policy access date;
|
|
79
|
-
- protocol, registration, analysis plan, amendments, and reporting guideline;
|
|
80
|
-
- manuscript or section scope;
|
|
81
|
-
- verified source manifest and claim registry;
|
|
82
|
-
- methods, results, tables, figures, and supplements;
|
|
83
|
-
- authorship, CRediT, declarations, and approval records;
|
|
84
|
-
- confidentiality classification and authorized processing boundary;
|
|
85
|
-
- data, code, materials, and repository constraints.
|
|
86
|
-
|
|
87
|
-
Do not ask for restricted source material if metadata or a local user-run audit is
|
|
88
|
-
sufficient.
|
|
89
|
-
|
|
90
|
-
## Workflow
|
|
91
|
-
|
|
92
|
-
### 1. Establish the local workspace
|
|
93
|
-
|
|
94
|
-
For a new draft, optionally generate fail-closed Markdown, JSON, and CSV scaffolds:
|
|
95
|
-
|
|
96
|
-
```bash
|
|
97
|
-
python3 scripts/scaffold_manuscript.py \
|
|
98
|
-
--output-dir ./draft-workspace \
|
|
99
|
-
--document-id local-draft \
|
|
100
|
-
--study-design randomized_trial \
|
|
101
|
-
--guideline consort-2025
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
The generator never overwrites files. Its output is explicitly not submission-ready and
|
|
105
|
-
contains placeholders that the linter rejects.
|
|
106
|
-
|
|
107
|
-
### 2. Select reporting guidance
|
|
108
|
-
|
|
109
|
-
Choose by actual design and article type, then open the current official statement,
|
|
110
|
-
checklist, explanation document, extensions, and target-journal instructions.
|
|
111
|
-
|
|
112
|
-
```bash
|
|
113
|
-
python3 scripts/select_reporting_guidelines.py select \
|
|
114
|
-
--study-design randomized_trial
|
|
115
|
-
```
|
|
116
|
-
|
|
117
|
-
Current major routes researched on 2026-07-24 include CONSORT 2025, SPIRIT 2025,
|
|
118
|
-
PRISMA 2020, STROBE, STARD and STARD-AI, TRIPOD+AI, CARE, ARRIVE 2.0, SQUIRE 2.0,
|
|
119
|
-
and CHEERS 2022 [SW-S06–SW-S18].
|
|
120
|
-
|
|
121
|
-
The selector is non-scoring. It does not certify quality, compliance, completeness, or
|
|
122
|
-
acceptance. See `references/reporting_guidelines.md`.
|
|
123
|
-
|
|
124
|
-
### 3. Build the evidence record
|
|
125
|
-
|
|
126
|
-
Assign:
|
|
127
|
-
|
|
128
|
-
- `E` IDs to sources in `source_manifest.json`;
|
|
129
|
-
- `C` IDs to claims in `claims.csv`;
|
|
130
|
-
- `N`, `M`, `O`, and `R` IDs to numeric facts, methods, outcomes, and results in
|
|
131
|
-
`consistency_manifest.json`.
|
|
132
|
-
|
|
133
|
-
Store a hash of claim text in CSV rather than raw claim text. During drafting, append:
|
|
134
|
-
|
|
135
|
-
```text
|
|
136
|
-
[claim:C001] [evidence:E001,E002]
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
Do not mark a source verified until an accountable human has opened it and confirmed
|
|
140
|
-
the exact support.
|
|
141
|
-
|
|
142
|
-
### 4. Create an evidence outline
|
|
143
|
-
|
|
144
|
-
Outline only from recorded evidence:
|
|
145
|
-
|
|
146
|
-
- objective or question;
|
|
147
|
-
- section purpose;
|
|
148
|
-
- claim IDs and evidence IDs;
|
|
149
|
-
- methods and result IDs;
|
|
150
|
-
- analysis intent and uncertainty;
|
|
151
|
-
- unresolved conflicts or missing information;
|
|
152
|
-
- applicable reporting topics.
|
|
153
|
-
|
|
154
|
-
Keep unsupported content in an unresolved-issues list, not manuscript prose.
|
|
155
|
-
|
|
156
|
-
### 5. Draft without adding facts
|
|
157
|
-
|
|
158
|
-
Transform the verified outline into venue-appropriate prose. Preserve all IDs during
|
|
159
|
-
drafting.
|
|
160
|
-
|
|
161
|
-
- Match title and abstract to the completed main text.
|
|
162
|
-
- Describe methods as performed.
|
|
163
|
-
- Present results in the declared order and analysis population.
|
|
164
|
-
- Separate result from interpretation unless the venue combines them.
|
|
165
|
-
- Compare with prior evidence only after verifying it.
|
|
166
|
-
- Keep conclusions within the observed design, population, and uncertainty.
|
|
167
|
-
|
|
168
|
-
Use IMRAD only when appropriate. Structured abstracts, lists, combined sections, and
|
|
169
|
-
alternative structures depend on study design and venue. See
|
|
170
|
-
`references/imrad_structure.md` and `references/writing_principles.md`.
|
|
171
|
-
|
|
172
|
-
### 6. Reconcile methods and results
|
|
173
|
-
|
|
174
|
-
Record repeated numeric facts and method-result mappings, then run:
|
|
175
|
-
|
|
176
|
-
```bash
|
|
177
|
-
python3 scripts/check_consistency.py consistency_manifest.json
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
Resolve every mismatch manually. A changed value may be a legitimate analysis-set
|
|
181
|
-
difference, but that difference must be named rather than silently normalized.
|
|
182
|
-
|
|
183
|
-
### 7. Verify citations and claims
|
|
184
|
-
|
|
185
|
-
```bash
|
|
186
|
-
python3 scripts/validate_manifest.py source_manifest.json \
|
|
187
|
-
--kind source --require-verified
|
|
188
|
-
python3 scripts/audit_claims.py manuscript.md claims.csv source_manifest.json
|
|
189
|
-
python3 scripts/check_references.py source_manifest.json
|
|
190
|
-
```
|
|
191
|
-
|
|
192
|
-
The reference checker validates syntax and duplicate identifiers without network
|
|
193
|
-
resolution. A human must still compare every identifier and quotation with the opened
|
|
194
|
-
source. Follow NLM *Citing Medicine* or the current official style required by the
|
|
195
|
-
venue [SW-S20, SW-S21].
|
|
196
|
-
|
|
197
|
-
### 8. Validate authorship and disclosure
|
|
198
|
-
|
|
199
|
-
Use journal criteria for authorship. Record the standardized CRediT roles as
|
|
200
|
-
contribution metadata; CRediT does not itself define authorship [SW-S19].
|
|
201
|
-
|
|
202
|
-
If AI was used, humans must verify all affected content and disclose the tool and
|
|
203
|
-
purpose according to current journal and publisher policy. ICMJE's January 2026
|
|
204
|
-
Recommendations require transparency and retain human accountability [SW-S01, SW-S02].
|
|
205
|
-
|
|
206
|
-
```bash
|
|
207
|
-
python3 scripts/validate_authorship.py authorship.json
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
Do not generate a disclosure from assumptions. See
|
|
211
|
-
`references/authorship_ai_confidentiality.md`.
|
|
212
|
-
|
|
213
|
-
### 9. Review declarations and open-science statements
|
|
214
|
-
|
|
215
|
-
Verify each statement independently:
|
|
216
|
-
|
|
217
|
-
- ethics and consent;
|
|
218
|
-
- registration and protocol;
|
|
219
|
-
- funding and sponsor role;
|
|
220
|
-
- conflicts and relationships;
|
|
221
|
-
- author contributions and acknowledgments;
|
|
222
|
-
- data, code, materials, and protocol availability;
|
|
223
|
-
- AI use.
|
|
224
|
-
|
|
225
|
-
Be as open as rights and responsibilities permit, but do not expose confidential,
|
|
226
|
-
personal, proprietary, licensed, or protected information. Record actual access
|
|
227
|
-
conditions. See `references/research_integrity_open_science.md`.
|
|
228
|
-
|
|
229
|
-
### 10. Use figures and tables only when warranted
|
|
230
|
-
|
|
231
|
-
Figures and tables are optional and provenance-bound. This skill does not generate
|
|
232
|
-
images or schematics.
|
|
233
|
-
|
|
234
|
-
For every retained display:
|
|
235
|
-
|
|
236
|
-
- link source data, code, transformations, and evidence IDs;
|
|
237
|
-
- reconcile values with prose and registries;
|
|
238
|
-
- document image processing, permissions, and licenses;
|
|
239
|
-
- include units, denominators, sample sizes, uncertainty, and analysis population;
|
|
240
|
-
- provide alt text and redundant non-color cues;
|
|
241
|
-
- perform a manual accessibility and scientific check at final size.
|
|
242
|
-
|
|
243
|
-
See `references/figures_tables.md`.
|
|
244
|
-
|
|
245
|
-
### 11. Record non-scoring guideline coverage
|
|
246
|
-
|
|
247
|
-
Record each bundled high-level topic as addressed, not applicable with rationale, or
|
|
248
|
-
missing:
|
|
249
|
-
|
|
250
|
-
```bash
|
|
251
|
-
python3 scripts/select_reporting_guidelines.py check reporting_coverage.json
|
|
252
|
-
```
|
|
253
|
-
|
|
254
|
-
Then complete the official checklist using actual manuscript locations. Never claim
|
|
255
|
-
adherence merely because the local coverage file passes.
|
|
256
|
-
|
|
257
|
-
### 12. Lint and approve
|
|
258
|
-
|
|
259
|
-
```bash
|
|
260
|
-
python3 scripts/validate_manifest.py manuscript_manifest.json --kind manuscript
|
|
261
|
-
python3 scripts/lint_manuscript.py manuscript.md \
|
|
262
|
-
--manifest manuscript_manifest.json
|
|
263
|
-
```
|
|
264
|
-
|
|
265
|
-
The linter reports issue codes and line numbers without echoing manuscript text.
|
|
266
|
-
Sensitive-content warnings require manual review and are not a de-identification
|
|
267
|
-
certificate.
|
|
268
|
-
|
|
269
|
-
Only accountable humans may:
|
|
270
|
-
|
|
271
|
-
- resolve scientific ambiguities;
|
|
272
|
-
- approve author order and declarations;
|
|
273
|
-
- approve external disclosure or transfer;
|
|
274
|
-
- set `submission_ready` to true;
|
|
275
|
-
- remove the draft banner;
|
|
276
|
-
- authorize submission.
|
|
277
|
-
|
|
278
|
-
## Revision and peer review
|
|
279
|
-
|
|
280
|
-
Treat reviewer material as confidential. Do not upload it to an external service without
|
|
281
|
-
the required authorization and policy review [SW-S01, SW-S24].
|
|
282
|
-
|
|
283
|
-
For each requested change:
|
|
284
|
-
|
|
285
|
-
1. record the comment without exposing it outside the approved boundary;
|
|
286
|
-
2. classify it as editorial, scientific, statistical, policy, or unresolved;
|
|
287
|
-
3. identify affected claims, evidence, methods, results, and displays;
|
|
288
|
-
4. revise the registries before prose when facts change;
|
|
289
|
-
5. re-run every affected audit;
|
|
290
|
-
6. draft a response that states what changed and where;
|
|
291
|
-
7. obtain human approval.
|
|
292
|
-
|
|
293
|
-
Do not comply with a request that would fabricate, hide, overstate, or breach policy.
|
|
294
|
-
|
|
295
|
-
## Current policy caution
|
|
296
|
-
|
|
297
|
-
COPE's 2017 Core Practices were retired in 2024. As of 2026-07-24, COPE announced that
|
|
298
|
-
a replacement Code of Conduct would be published in 2026; do not describe the archived
|
|
299
|
-
Core Practices as current membership standards [SW-S04, SW-S05]. Distinguish formal
|
|
300
|
-
COPE positions from discussion documents, webinars, comments, and case advice.
|
|
301
|
-
|
|
302
|
-
## Formatting and submission
|
|
303
|
-
|
|
304
|
-
The former LaTeX assets were removed because a generic polished template could allow
|
|
305
|
-
plausible placeholders to ship. Use the Markdown scaffold and structured records.
|
|
306
|
-
Apply the target venue's current controlled template only after verification.
|
|
307
|
-
|
|
308
|
-
See:
|
|
309
|
-
|
|
310
|
-
- `assets/REPORT_FORMATTING_GUIDE.md`
|
|
311
|
-
- `references/professional_report_formatting.md`
|
|
312
|
-
- `references/journal_policies.md`
|
|
313
|
-
|
|
314
|
-
Formatting cannot convert an incomplete evidence record into a submission-ready paper.
|
|
315
|
-
|
|
316
|
-
## Bundled files
|
|
317
|
-
|
|
318
|
-
### Assets
|
|
319
|
-
|
|
320
|
-
- `assets/manuscript_scaffold.md`
|
|
321
|
-
- `assets/manuscript_manifest_template.json`
|
|
322
|
-
- `assets/source_manifest_template.json`
|
|
323
|
-
- `assets/claim_evidence_template.csv`
|
|
324
|
-
- `assets/consistency_manifest_template.json`
|
|
325
|
-
- `assets/authorship_template.json`
|
|
326
|
-
- `assets/reporting_coverage_template.json`
|
|
327
|
-
- `assets/reporting_guidelines.json`
|
|
328
|
-
|
|
329
|
-
### Scripts
|
|
330
|
-
|
|
331
|
-
- `scripts/scaffold_manuscript.py`
|
|
332
|
-
- `scripts/validate_manifest.py`
|
|
333
|
-
- `scripts/select_reporting_guidelines.py`
|
|
334
|
-
- `scripts/audit_claims.py`
|
|
335
|
-
- `scripts/check_consistency.py`
|
|
336
|
-
- `scripts/check_references.py`
|
|
337
|
-
- `scripts/validate_authorship.py`
|
|
338
|
-
- `scripts/lint_manuscript.py`
|
|
339
|
-
|
|
340
|
-
All scripts are local, deterministic, bounded, dependency-free, and network-free. See
|
|
341
|
-
`references/cli_reference.md`.
|
|
342
|
-
|
|
343
|
-
### References
|
|
344
|
-
|
|
345
|
-
- `references/evidence_workflow.md`
|
|
346
|
-
- `references/writing_principles.md`
|
|
347
|
-
- `references/imrad_structure.md`
|
|
348
|
-
- `references/citation_styles.md`
|
|
349
|
-
- `references/reporting_guidelines.md`
|
|
350
|
-
- `references/figures_tables.md`
|
|
351
|
-
- `references/authorship_ai_confidentiality.md`
|
|
352
|
-
- `references/research_integrity_open_science.md`
|
|
353
|
-
- `references/journal_policies.md`
|
|
354
|
-
- `references/professional_report_formatting.md`
|
|
355
|
-
- `references/cli_reference.md`
|
|
356
|
-
- `references/source_ledger.md`
|