@yeyuan98/opencode-bioresearcher-plugin 1.5.2 → 1.5.3

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.
@@ -1,613 +1,613 @@
1
- # Reference-Based Report Template
2
-
3
- Standardized template for professional research reports with complete data provenance and citations.
4
-
5
- ## Overview
6
-
7
- This pattern defines the mandatory structure for all bioresearcher agent reports, ensuring:
8
- - Complete data provenance documentation
9
- - Clear analysis methodology
10
- - Proper citations and bibliography
11
- - Reproducible research
12
-
13
- ---
14
-
15
- ## Complete Report Template
16
-
17
- ```markdown
18
- # [Research Topic Title]
19
-
20
- **Generated by:** BioResearcher AI Agent
21
- **Date:** [YYYY-MM-DD]
22
- **Research Scope:** [Brief description of research question in 1-2 sentences]
23
-
24
- ---
25
-
26
- ## Executive Summary
27
-
28
- [2-3 sentence overview of key findings with most critical citations [1, 2]]
29
-
30
- **Key Findings:**
31
- - [Finding 1 with citation [1]]
32
- - [Finding 2 with citation [2]]
33
- - [Finding 3 with citation [3]]
34
-
35
- ---
36
-
37
- ## 1. Data Sources
38
-
39
- ### 1.1 Primary Data Origin
40
-
41
- **Source Type:** [Database / Literature / Clinical Trials / Web / Local Files / Mixed]
42
-
43
- **Source Details:**
44
-
45
- | Source | Type | Location/Query | Date Accessed |
46
- |--------|------|----------------|---------------|
47
- | [Source 1] | [Database/Literature/Web] | [File path, URL, or query] | [YYYY-MM-DD] |
48
- | [Source 2] | [Database/Literature/Web] | [File path, URL, or query] | [YYYY-MM-DD] |
49
-
50
- **Data Scope:**
51
- - **Records Retrieved:** [Number]
52
- - **Date Range:** [Start date - End date, if applicable]
53
- - **Filters Applied:** [List filters used]
54
- - **Sample Size:** [Final dataset size after filtering]
55
-
56
- ### 1.2 Data Access Method
57
-
58
- **Tools Used:**
59
- - [Tool 1: e.g., dbQuery]
60
- - [Tool 2: e.g., biomcp_article_searcher]
61
- - [Tool 3: e.g., tableFilterRows]
62
-
63
- **Queries/Filters Applied:**
64
-
65
- ```sql
66
- -- Database query example
67
- SELECT * FROM clinical_trials
68
- WHERE phase = 'Phase 3'
69
- AND status = 'Recruiting'
70
- AND condition LIKE '%melanoma%'
71
- ```
72
-
73
- ```python
74
- # BioMCP query example
75
- biomcp_article_searcher(
76
- genes=["BRAF"],
77
- diseases=["melanoma"],
78
- keywords=["treatment resistance"],
79
- page_size=50
80
- )
81
- ```
82
-
83
- ```typescript
84
- // Table filter example
85
- tableFilterRows(
86
- file_path="data/trials.xlsx",
87
- column="Phase",
88
- operator="=",
89
- value="Phase 3"
90
- )
91
- ```
92
-
93
- ### 1.3 Data Quality Notes
94
-
95
- **Completeness:**
96
- - [Any missing data or gaps]
97
- - [Fields with null values: %]
98
-
99
- **Limitations:**
100
- - [Limitation 1: e.g., "Data only includes trials registered after 2020"]
101
- - [Limitation 2: e.g., "Non-English publications excluded"]
102
-
103
- **Quality Assessment:**
104
- - [How data quality was verified]
105
- - [Any validation steps taken]
106
-
107
- ---
108
-
109
- ## 2. Analysis Methodology
110
-
111
- ### 2.1 Analysis Approach
112
-
113
- **Selected Approach:** [Table Tools / long-table-summary Skill / Custom Python / Hybrid]
114
-
115
- **Decision Rationale:**
116
- - [Why this approach was chosen over alternatives]
117
- - [Example: "Selected long-table-summary skill due to dataset size (150 rows) and need for structured classification output"]
118
-
119
- ### 2.2 Tools & Skills Used
120
-
121
- **Skills Loaded:**
122
- - [Skill 1: e.g., bioresearcher-core]
123
- - [Skill 2: e.g., long-table-summary]
124
-
125
- **Tools Applied:**
126
- 1. [Tool 1 with purpose]
127
- 2. [Tool 2 with purpose]
128
- 3. [Tool 3 with purpose]
129
-
130
- **Python Scripts:**
131
- - [Script path 1: e.g., .scripts/py/trial_analysis.py]
132
- - [Script path 2: e.g., .scripts/py/statistical_tests.py]
133
-
134
- ### 2.3 Analysis Steps
135
-
136
- **Step 1: [Step Name]**
137
- - Tool/Skill: [Tool or skill used]
138
- - Action: [What was done]
139
- - Result: [Outcome]
140
-
141
- **Step 2: [Step Name]**
142
- - Tool/Skill: [Tool or skill used]
143
- - Action: [What was done]
144
- - Result: [Outcome]
145
-
146
- **Step 3: [Step Name]**
147
- - Tool/Skill: [Tool or skill used]
148
- - Action: [What was done]
149
- - Result: [Outcome]
150
-
151
- [Continue for all steps]
152
-
153
- ### 2.4 Validation & Quality Control
154
-
155
- **Validation Method:**
156
- - [Method: e.g., jsonValidate with schema, manual review, cross-referencing]
157
- - [Sample size validated: X of Y records]
158
-
159
- **Error Handling:**
160
- - [Retry logic applied: Yes/No]
161
- - [Failed operations: Number and reasons]
162
- - [Fallback approaches: Description]
163
-
164
- **Data Verification:**
165
- - [How results were verified for accuracy]
166
- - [Cross-validation with other sources: Yes/No, details]
167
-
168
- ---
169
-
170
- ## 3. Findings
171
-
172
- ### 3.1 [Finding Category 1]
173
-
174
- [Detailed description of findings with inline citations [1, 2, 3]]
175
-
176
- **Key Data Points:**
177
-
178
- | Metric | Value | Confidence | Source |
179
- |--------|-------|------------|--------|
180
- | [Metric 1] | [Value] | [High/Medium/Low] | [Citation] |
181
- | [Metric 2] | [Value] | [High/Medium/Low] | [Citation] |
182
- | [Metric 3] | [Value] | [High/Medium/Low] | [Citation] |
183
-
184
- **Supporting Evidence:**
185
- - [Evidence 1 with citation [4]]
186
- - [Evidence 2 with citation [5]]
187
-
188
- **Visual Representation:**
189
- [If applicable, include or reference charts/tables]
190
-
191
- ### 3.2 [Finding Category 2]
192
-
193
- [Detailed description with inline citations [6, 7]]
194
-
195
- **Comparison Table:**
196
-
197
- | Category | Group A | Group B | Difference | P-value | Source |
198
- |----------|---------|---------|------------|---------|--------|
199
- | [Metric] | [Value] | [Value] | [+/- X%] | [0.XX] | [Citation] |
200
-
201
- **Trends Observed:**
202
- - [Trend 1 with citation [8]]
203
- - [Trend 2 with citation [9]]
204
-
205
- ### 3.3 [Finding Category 3]
206
-
207
- [Continue structure for additional findings]
208
-
209
- ---
210
-
211
- ## 4. Limitations & Considerations
212
-
213
- ### 4.1 Data Limitations
214
-
215
- **Coverage Gaps:**
216
- - [Gap 1: e.g., "Limited to English-language publications"]
217
- - [Gap 2: e.g., "Database only includes trials from US/Europe"]
218
-
219
- **Temporal Limitations:**
220
- - [Date range limitations]
221
- - [Outdated information concerns]
222
-
223
- **Quality Limitations:**
224
- - [Data quality issues]
225
- - [Potential biases]
226
-
227
- ### 4.2 Methodological Limitations
228
-
229
- **Analysis Constraints:**
230
- - [Constraint 1: e.g., "Sample size too small for statistical significance"]
231
- - [Constraint 2: e.g., "Unable to control for confounding variables"]
232
-
233
- **Tool Limitations:**
234
- - [Tool limitation 1]
235
- - [Tool limitation 2]
236
-
237
- ### 4.3 Generalizability
238
-
239
- **Applicability:**
240
- - [Where findings can be applied]
241
- - [Where findings may not apply]
242
-
243
- **Extrapolation Risks:**
244
- - [Risks of over-generalizing results]
245
-
246
- ---
247
-
248
- ## 5. Recommendations
249
-
250
- ### 5.1 Primary Recommendations
251
-
252
- **Recommendation 1: [Title]**
253
- - **Action:** [Specific action recommended]
254
- - **Rationale:** [Why this action is recommended]
255
- - **Supporting Evidence:** [Citation [10]]
256
- - **Priority:** [High/Medium/Low]
257
-
258
- **Recommendation 2: [Title]**
259
- - **Action:** [Specific action recommended]
260
- - **Rationale:** [Why this action is recommended]
261
- - **Supporting Evidence:** [Citation [11]]
262
- - **Priority:** [High/Medium/Low]
263
-
264
- ### 5.2 Future Research Directions
265
-
266
- - [Direction 1 with rationale]
267
- - [Direction 2 with rationale]
268
-
269
- ---
270
-
271
- ## References
272
-
273
- ### Published Research
274
-
275
- [1] Author1 AB, Author2 CD, Author3 EF, et al. Article Title. Journal Name. Year;Volume(Issue):Pages. PMID: XXXXXXXX.
276
-
277
- [2] Author4 GH, Author5 IJ. Another Article Title. Another Journal. Year;Volume(Issue):Pages. DOI: 10.XXXX/XXXXX.
278
-
279
- ### Clinical Trials
280
-
281
- [3] NCT04280705: A Study of Encorafenib Plus Cetuximab With or Without Nivolumab in Metastatic Colorectal Cancer. Phase 2. Sponsor: Pfizer. Status: Completed. https://clinicaltrials.gov/ct2/show/NCT04280705
282
-
283
- ### Web Sources
284
-
285
- [4] Page Title. Website Name. Published/Updated: YYYY-MM-DD. URL. Accessed: YYYY-MM-DD.
286
-
287
- ### Databases
288
-
289
- [5] Database Name. Version X.Y. Organization. Query: [SQL or search criteria]. Accessed: YYYY-MM-DD.
290
-
291
- ### Drug/Gene/Variant Information
292
-
293
- [6] BRAF: B-Raf proto-oncogene, serine/threonine kinase. Entrez ID: 673. HGNC ID: HGNC:1097. https://www.ncbi.nlm.nih.gov/gene/673
294
-
295
- [7] Vemurafenib. DrugBank ID: DB08881. ChEMBL ID: CHEMBL1229511. https://go.drugbank.com/drugs/DB08881
296
-
297
- ---
298
-
299
- ## Appendix
300
-
301
- ### A. Raw Data
302
-
303
- **Data Availability:**
304
- - [Location of raw data files]
305
- - [Data format: Excel, CSV, JSON]
306
- - [File sizes]
307
-
308
- **Access Instructions:**
309
- [How to access the raw data]
310
-
311
- ### B. Analysis Code
312
-
313
- **Python Scripts:**
314
- - [Script 1: .scripts/py/[name].py]
315
- - [Script 2: .scripts/py/[name].py]
316
-
317
- **Configuration Files:**
318
- - [Config file paths, if any]
319
-
320
- ### C. Reproducibility Notes
321
-
322
- **Environment:**
323
- - Python version: [X.Y.Z]
324
- - Key dependencies: [pandas X.Y.Z, numpy X.Y.Z]
325
- - Package manager: uv
326
-
327
- **Reproduction Steps:**
328
- 1. [Step 1]
329
- 2. [Step 2]
330
- 3. [Step 3]
331
-
332
- **Expected Output:**
333
- [Description of expected results if analysis is reproduced]
334
-
335
- ---
336
-
337
- **Report prepared by:** BioResearcher AI Agent
338
- **Research completed:** [YYYY-MM-DD HH:MM]
339
- **Report generated:** [YYYY-MM-DD HH:MM]
340
- **Total sources cited:** [N]
341
- ```
342
-
343
- ---
344
-
345
- ## Data Provenance Requirements
346
-
347
- ### Rule 1: Every Claim Must Have Provenance
348
-
349
- **Three options (at least one required):**
350
-
351
- 1. **Citation** - Reference to bibliography [N]
352
- 2. **Data Source** - Explicit mention of where data came from
353
- 3. **Analysis Method** - How the conclusion was derived
354
-
355
- ### Example: Proper vs. Improper Provenance
356
-
357
- #### ❌ BAD: No Provenance
358
- ```markdown
359
- BRAF V600E is found in 50% of melanomas.
360
- ```
361
-
362
- #### ⚠️ ADEQUATE: Citation Only
363
- ```markdown
364
- BRAF V600E is found in approximately 50% of melanomas [1].
365
- ```
366
-
367
- #### ✅ GOOD: Complete Provenance
368
- ```markdown
369
- BRAF V600E mutations are found in approximately 50% of cutaneous melanomas
370
- [1], based on analysis of 2,847 patient samples from the TCGA database
371
- (query performed 2024-01-15, filter: primary melanoma, stage II-IV).
372
-
373
- This finding is consistent with previous reports showing 40-60% prevalence
374
- in this population [2, 3].
375
- ```
376
-
377
- ---
378
-
379
- ## Citation Standards
380
-
381
- ### In-Text Citation Format
382
-
383
- **Single Source:**
384
- ```markdown
385
- BRAF V600E mutations are found in approximately 50% of melanomas [1].
386
- ```
387
-
388
- **Multiple Sources:**
389
- ```markdown
390
- Several studies have confirmed this association [1, 2, 3].
391
- ```
392
-
393
- **Range of Sources:**
394
- ```markdown
395
- This has been extensively documented [1-5].
396
- ```
397
-
398
- **Specific Claims:**
399
- ```markdown
400
- The drug was approved in 2011 [1] and has since become standard of care [2, 3].
401
- ```
402
-
403
- ### Bibliography Format by Source Type
404
-
405
- #### Published Research
406
- ```
407
- [N] Author1 AB, Author2 CD, Author3 EF, et al. Article Title. Journal Name. Year;Volume(Issue):Pages. PMID: XXXXXXXX.
408
- ```
409
-
410
- **Example:**
411
- ```
412
- [1] Chapman PB, Hauschild A, Robert C, et al. Improved survival with vemurafenib in melanoma with BRAF V600E mutation. N Engl J Med. 2011;364(26):2507-2516. PMID: 21639808.
413
- ```
414
-
415
- #### Clinical Trials
416
- ```
417
- [N] NCT ID: Trial Title. Phase X. Sponsor: Company/Institution. Status: Recruiting/Completed. URL
418
- ```
419
-
420
- **Example:**
421
- ```
422
- [2] NCT04280705: A Study of Encorafenib Plus Cetuximab With or Without Nivolumab in Metastatic Colorectal Cancer. Phase 2. Sponsor: Pfizer. Status: Completed. https://clinicaltrials.gov/ct2/show/NCT04280705
423
- ```
424
-
425
- #### Web Sources
426
- ```
427
- [N] Page Title. Website Name. Published/Updated Date. URL. Accessed: YYYY-MM-DD.
428
- ```
429
-
430
- **Example:**
431
- ```
432
- [3] BRAF Gene. National Cancer Institute. Updated 2024. https://www.cancer.gov/about-cancer/causes-prevention/genetics/brca-genes. Accessed: 2024-01-15.
433
- ```
434
-
435
- #### Databases
436
- ```
437
- [N] Database Name. Version X.Y. Organization. Query: [SQL or search criteria]. Accessed: YYYY-MM-DD.
438
- ```
439
-
440
- **Example:**
441
- ```
442
- [4] ClinicalTrials.gov Database. U.S. National Library of Medicine. Query: "melanoma AND Phase 3 AND Recruiting". Accessed: 2024-01-15.
443
- ```
444
-
445
- #### Drug/Gene/Variant Information
446
- ```
447
- [N] Gene Symbol: Gene Name. Entrez ID: XXXXXX. HGNC ID: HGNC:XXXX. URL
448
- ```
449
-
450
- **Example:**
451
- ```
452
- [5] BRAF: B-Raf proto-oncogene, serine/threonine kinase. Entrez ID: 673. HGNC ID: HGNC:1097. https://www.ncbi.nlm.nih.gov/gene/673
453
- ```
454
-
455
- ---
456
-
457
- ## Report Quality Checklist
458
-
459
- Before finalizing report, verify:
460
-
461
- ### Data Sources Section
462
- - [ ] All data sources listed with types
463
- - [ ] Access dates provided for all sources
464
- - [ ] Queries/filters documented
465
- - [ ] Data scope clearly defined
466
- - [ ] Quality limitations noted
467
-
468
- ### Analysis Methodology Section
469
- - [ ] Analysis approach explained
470
- - [ ] Decision rationale provided
471
- - [ ] All tools/skills listed
472
- - [ ] Step-by-step process documented
473
- - [ ] Validation methods described
474
-
475
- ### Findings Section
476
- - [ ] All claims have citations
477
- - [ ] Data provenance provided
478
- - [ ] Confidence levels stated
479
- - [ ] Supporting evidence included
480
- - [ ] Tables/figures referenced
481
-
482
- ### Limitations Section
483
- - [ ] Data gaps acknowledged
484
- - [ ] Methodological constraints noted
485
- - [ ] Generalizability discussed
486
-
487
- ### References Section
488
- - [ ] All in-text citations in bibliography
489
- - [ ] Format consistent by source type
490
- - [ ] URLs/PMIDs/DOIs included
491
- - [ ] Access dates for web sources
492
- - [ ] Alphabetically numbered (not by author)
493
-
494
- ### Appendix Section
495
- - [ ] Raw data location provided
496
- - [ ] Analysis code referenced
497
- - [ ] Reproducibility notes included
498
-
499
- ---
500
-
501
- ## Template Usage Examples
502
-
503
- ### Example 1: Literature Review Report
504
-
505
- ```markdown
506
- # BRAF V600E Mutation Prevalence in Melanoma
507
-
508
- **Generated by:** BioResearcher AI Agent
509
- **Date:** 2024-01-15
510
- **Research Scope:** Systematic review of BRAF V600E mutation prevalence
511
- in cutaneous melanoma across published studies
512
-
513
- ---
514
-
515
- ## Executive Summary
516
-
517
- BRAF V600E mutations occur in approximately 50% of cutaneous melanomas
518
- [1, 2], with prevalence varying by geographic region and melanoma subtype
519
- [3]. This review analyzed 15 studies encompassing 8,247 patients.
520
-
521
- **Key Findings:**
522
- - Overall prevalence: 48-52% in cutaneous melanoma [1, 2, 3]
523
- - Higher in chronic sun-damaged skin: 56% [4]
524
- - Lower in acral melanoma: 15-20% [5]
525
-
526
- [Continue with full template sections...]
527
- ```
528
-
529
- ### Example 2: Clinical Trial Analysis Report
530
-
531
- ```markdown
532
- # Phase 3 Melanoma Trials Analysis
533
-
534
- **Generated by:** BioResearcher AI Agent
535
- **Date:** 2024-01-15
536
- **Research Scope:** Analysis of recruiting Phase 3 clinical trials for
537
- melanoma treatments
538
-
539
- ---
540
-
541
- ## 1. Data Sources
542
-
543
- ### 1.1 Primary Data Origin
544
-
545
- **Source Type:** Database (ClinicalTrials.gov)
546
-
547
- **Source Details:**
548
-
549
- | Source | Type | Location/Query | Date Accessed |
550
- |--------|------|----------------|---------------|
551
- | ClinicalTrials.gov | Database | API + web scraping | 2024-01-15 |
552
-
553
- **Data Scope:**
554
- - **Records Retrieved:** 127 trials
555
- - **Date Range:** 2000-2024
556
- - **Filters Applied:** Phase 3, Melanoma, Recruiting
557
- - **Sample Size:** 127 trials
558
-
559
- [Continue with full template sections...]
560
- ```
561
-
562
- ---
563
-
564
- ## Common Mistakes to Avoid
565
-
566
- ### Mistake 1: Missing Data Provenance
567
- ```
568
- ❌ BAD: "Response rates were 65%"
569
- ✅ GOOD: "Response rates were 65% [1] based on analysis of 42 Phase 3
570
- trials from ClinicalTrials.gov (accessed 2024-01-15, filter:
571
- melanoma AND recruiting)"
572
- ```
573
-
574
- ### Mistake 2: Incomplete Methodology
575
- ```
576
- ❌ BAD: "We analyzed the data"
577
- ✅ GOOD: "Analysis was performed using tableGroupBy tool to aggregate
578
- trials by phase, followed by custom Python statistical analysis
579
- (.scripts/py/trial_statistics.py) to compare response rates"
580
- ```
581
-
582
- ### Mistake 3: Inconsistent Citations
583
- ```
584
- ❌ BAD: Mixed citation styles, missing PMIDs
585
- ✅ GOOD: Consistent format by source type, all identifiers included
586
- ```
587
-
588
- ### Mistake 4: No Limitations Section
589
- ```
590
- ❌ BAD: Presenting findings as absolute truth
591
- ✅ GOOD: Acknowledging data gaps, methodological constraints, and
592
- generalizability limits
593
- ```
594
-
595
- ---
596
-
597
- ## Report Review Process
598
-
599
- ### Self-Review Checklist
600
-
601
- 1. **Provenance Check:** Every claim has source citation or data origin
602
- 2. **Citation Check:** All [N] references exist in bibliography
603
- 3. **Format Check:** Bibliography follows source-type templates
604
- 4. **Completeness Check:** All template sections present
605
- 5. **Clarity Check:** Technical terms explained
606
- 6. **Accuracy Check:** Numbers and statistics verified
607
-
608
- ### Quality Standards
609
-
610
- - **Transparency:** All methods and data sources documented
611
- - **Reproducibility:** Another researcher could reproduce results
612
- - **Credibility:** High-quality sources, proper citations
613
- - **Professionalism:** Academic writing standards, clear structure
1
+ # Reference-Based Report Template
2
+
3
+ Standardized template for professional research reports with complete data provenance and citations.
4
+
5
+ ## Overview
6
+
7
+ This pattern defines the mandatory structure for all bioresearcher agent reports, ensuring:
8
+ - Complete data provenance documentation
9
+ - Clear analysis methodology
10
+ - Proper citations and bibliography
11
+ - Reproducible research
12
+
13
+ ---
14
+
15
+ ## Complete Report Template
16
+
17
+ ```markdown
18
+ # [Research Topic Title]
19
+
20
+ **Generated by:** BioResearcher AI Agent
21
+ **Date:** [YYYY-MM-DD]
22
+ **Research Scope:** [Brief description of research question in 1-2 sentences]
23
+
24
+ ---
25
+
26
+ ## Executive Summary
27
+
28
+ [2-3 sentence overview of key findings with most critical citations [1, 2]]
29
+
30
+ **Key Findings:**
31
+ - [Finding 1 with citation [1]]
32
+ - [Finding 2 with citation [2]]
33
+ - [Finding 3 with citation [3]]
34
+
35
+ ---
36
+
37
+ ## 1. Data Sources
38
+
39
+ ### 1.1 Primary Data Origin
40
+
41
+ **Source Type:** [Database / Literature / Clinical Trials / Web / Local Files / Mixed]
42
+
43
+ **Source Details:**
44
+
45
+ | Source | Type | Location/Query | Date Accessed |
46
+ |--------|------|----------------|---------------|
47
+ | [Source 1] | [Database/Literature/Web] | [File path, URL, or query] | [YYYY-MM-DD] |
48
+ | [Source 2] | [Database/Literature/Web] | [File path, URL, or query] | [YYYY-MM-DD] |
49
+
50
+ **Data Scope:**
51
+ - **Records Retrieved:** [Number]
52
+ - **Date Range:** [Start date - End date, if applicable]
53
+ - **Filters Applied:** [List filters used]
54
+ - **Sample Size:** [Final dataset size after filtering]
55
+
56
+ ### 1.2 Data Access Method
57
+
58
+ **Tools Used:**
59
+ - [Tool 1: e.g., dbQuery]
60
+ - [Tool 2: e.g., biomcp_article_searcher]
61
+ - [Tool 3: e.g., tableFilterRows]
62
+
63
+ **Queries/Filters Applied:**
64
+
65
+ ```sql
66
+ -- Database query example
67
+ SELECT * FROM clinical_trials
68
+ WHERE phase = 'Phase 3'
69
+ AND status = 'Recruiting'
70
+ AND condition LIKE '%melanoma%'
71
+ ```
72
+
73
+ ```python
74
+ # BioMCP query example
75
+ biomcp_article_searcher(
76
+ genes=["BRAF"],
77
+ diseases=["melanoma"],
78
+ keywords=["treatment resistance"],
79
+ page_size=50
80
+ )
81
+ ```
82
+
83
+ ```typescript
84
+ // Table filter example
85
+ tableFilterRows(
86
+ file_path="data/trials.xlsx",
87
+ column="Phase",
88
+ operator="=",
89
+ value="Phase 3"
90
+ )
91
+ ```
92
+
93
+ ### 1.3 Data Quality Notes
94
+
95
+ **Completeness:**
96
+ - [Any missing data or gaps]
97
+ - [Fields with null values: %]
98
+
99
+ **Limitations:**
100
+ - [Limitation 1: e.g., "Data only includes trials registered after 2020"]
101
+ - [Limitation 2: e.g., "Non-English publications excluded"]
102
+
103
+ **Quality Assessment:**
104
+ - [How data quality was verified]
105
+ - [Any validation steps taken]
106
+
107
+ ---
108
+
109
+ ## 2. Analysis Methodology
110
+
111
+ ### 2.1 Analysis Approach
112
+
113
+ **Selected Approach:** [Table Tools / long-table-summary Skill / Custom Python / Hybrid]
114
+
115
+ **Decision Rationale:**
116
+ - [Why this approach was chosen over alternatives]
117
+ - [Example: "Selected long-table-summary skill due to dataset size (150 rows) and need for structured classification output"]
118
+
119
+ ### 2.2 Tools & Skills Used
120
+
121
+ **Skills Loaded:**
122
+ - [Skill 1: e.g., bioresearcher-core]
123
+ - [Skill 2: e.g., long-table-summary]
124
+
125
+ **Tools Applied:**
126
+ 1. [Tool 1 with purpose]
127
+ 2. [Tool 2 with purpose]
128
+ 3. [Tool 3 with purpose]
129
+
130
+ **Python Scripts:**
131
+ - [Script path 1: e.g., .scripts/py/trial_analysis.py]
132
+ - [Script path 2: e.g., .scripts/py/statistical_tests.py]
133
+
134
+ ### 2.3 Analysis Steps
135
+
136
+ **Step 1: [Step Name]**
137
+ - Tool/Skill: [Tool or skill used]
138
+ - Action: [What was done]
139
+ - Result: [Outcome]
140
+
141
+ **Step 2: [Step Name]**
142
+ - Tool/Skill: [Tool or skill used]
143
+ - Action: [What was done]
144
+ - Result: [Outcome]
145
+
146
+ **Step 3: [Step Name]**
147
+ - Tool/Skill: [Tool or skill used]
148
+ - Action: [What was done]
149
+ - Result: [Outcome]
150
+
151
+ [Continue for all steps]
152
+
153
+ ### 2.4 Validation & Quality Control
154
+
155
+ **Validation Method:**
156
+ - [Method: e.g., jsonValidate with schema, manual review, cross-referencing]
157
+ - [Sample size validated: X of Y records]
158
+
159
+ **Error Handling:**
160
+ - [Retry logic applied: Yes/No]
161
+ - [Failed operations: Number and reasons]
162
+ - [Fallback approaches: Description]
163
+
164
+ **Data Verification:**
165
+ - [How results were verified for accuracy]
166
+ - [Cross-validation with other sources: Yes/No, details]
167
+
168
+ ---
169
+
170
+ ## 3. Findings
171
+
172
+ ### 3.1 [Finding Category 1]
173
+
174
+ [Detailed description of findings with inline citations [1, 2, 3]]
175
+
176
+ **Key Data Points:**
177
+
178
+ | Metric | Value | Confidence | Source |
179
+ |--------|-------|------------|--------|
180
+ | [Metric 1] | [Value] | [High/Medium/Low] | [Citation] |
181
+ | [Metric 2] | [Value] | [High/Medium/Low] | [Citation] |
182
+ | [Metric 3] | [Value] | [High/Medium/Low] | [Citation] |
183
+
184
+ **Supporting Evidence:**
185
+ - [Evidence 1 with citation [4]]
186
+ - [Evidence 2 with citation [5]]
187
+
188
+ **Visual Representation:**
189
+ [If applicable, include or reference charts/tables]
190
+
191
+ ### 3.2 [Finding Category 2]
192
+
193
+ [Detailed description with inline citations [6, 7]]
194
+
195
+ **Comparison Table:**
196
+
197
+ | Category | Group A | Group B | Difference | P-value | Source |
198
+ |----------|---------|---------|------------|---------|--------|
199
+ | [Metric] | [Value] | [Value] | [+/- X%] | [0.XX] | [Citation] |
200
+
201
+ **Trends Observed:**
202
+ - [Trend 1 with citation [8]]
203
+ - [Trend 2 with citation [9]]
204
+
205
+ ### 3.3 [Finding Category 3]
206
+
207
+ [Continue structure for additional findings]
208
+
209
+ ---
210
+
211
+ ## 4. Limitations & Considerations
212
+
213
+ ### 4.1 Data Limitations
214
+
215
+ **Coverage Gaps:**
216
+ - [Gap 1: e.g., "Limited to English-language publications"]
217
+ - [Gap 2: e.g., "Database only includes trials from US/Europe"]
218
+
219
+ **Temporal Limitations:**
220
+ - [Date range limitations]
221
+ - [Outdated information concerns]
222
+
223
+ **Quality Limitations:**
224
+ - [Data quality issues]
225
+ - [Potential biases]
226
+
227
+ ### 4.2 Methodological Limitations
228
+
229
+ **Analysis Constraints:**
230
+ - [Constraint 1: e.g., "Sample size too small for statistical significance"]
231
+ - [Constraint 2: e.g., "Unable to control for confounding variables"]
232
+
233
+ **Tool Limitations:**
234
+ - [Tool limitation 1]
235
+ - [Tool limitation 2]
236
+
237
+ ### 4.3 Generalizability
238
+
239
+ **Applicability:**
240
+ - [Where findings can be applied]
241
+ - [Where findings may not apply]
242
+
243
+ **Extrapolation Risks:**
244
+ - [Risks of over-generalizing results]
245
+
246
+ ---
247
+
248
+ ## 5. Recommendations
249
+
250
+ ### 5.1 Primary Recommendations
251
+
252
+ **Recommendation 1: [Title]**
253
+ - **Action:** [Specific action recommended]
254
+ - **Rationale:** [Why this action is recommended]
255
+ - **Supporting Evidence:** [Citation [10]]
256
+ - **Priority:** [High/Medium/Low]
257
+
258
+ **Recommendation 2: [Title]**
259
+ - **Action:** [Specific action recommended]
260
+ - **Rationale:** [Why this action is recommended]
261
+ - **Supporting Evidence:** [Citation [11]]
262
+ - **Priority:** [High/Medium/Low]
263
+
264
+ ### 5.2 Future Research Directions
265
+
266
+ - [Direction 1 with rationale]
267
+ - [Direction 2 with rationale]
268
+
269
+ ---
270
+
271
+ ## References
272
+
273
+ ### Published Research
274
+
275
+ [1] Author1 AB, Author2 CD, Author3 EF, et al. Article Title. Journal Name. Year;Volume(Issue):Pages. PMID: XXXXXXXX.
276
+
277
+ [2] Author4 GH, Author5 IJ. Another Article Title. Another Journal. Year;Volume(Issue):Pages. DOI: 10.XXXX/XXXXX.
278
+
279
+ ### Clinical Trials
280
+
281
+ [3] NCT04280705: A Study of Encorafenib Plus Cetuximab With or Without Nivolumab in Metastatic Colorectal Cancer. Phase 2. Sponsor: Pfizer. Status: Completed. https://clinicaltrials.gov/ct2/show/NCT04280705
282
+
283
+ ### Web Sources
284
+
285
+ [4] Page Title. Website Name. Published/Updated: YYYY-MM-DD. URL. Accessed: YYYY-MM-DD.
286
+
287
+ ### Databases
288
+
289
+ [5] Database Name. Version X.Y. Organization. Query: [SQL or search criteria]. Accessed: YYYY-MM-DD.
290
+
291
+ ### Drug/Gene/Variant Information
292
+
293
+ [6] BRAF: B-Raf proto-oncogene, serine/threonine kinase. Entrez ID: 673. HGNC ID: HGNC:1097. https://www.ncbi.nlm.nih.gov/gene/673
294
+
295
+ [7] Vemurafenib. DrugBank ID: DB08881. ChEMBL ID: CHEMBL1229511. https://go.drugbank.com/drugs/DB08881
296
+
297
+ ---
298
+
299
+ ## Appendix
300
+
301
+ ### A. Raw Data
302
+
303
+ **Data Availability:**
304
+ - [Location of raw data files]
305
+ - [Data format: Excel, CSV, JSON]
306
+ - [File sizes]
307
+
308
+ **Access Instructions:**
309
+ [How to access the raw data]
310
+
311
+ ### B. Analysis Code
312
+
313
+ **Python Scripts:**
314
+ - [Script 1: .scripts/py/[name].py]
315
+ - [Script 2: .scripts/py/[name].py]
316
+
317
+ **Configuration Files:**
318
+ - [Config file paths, if any]
319
+
320
+ ### C. Reproducibility Notes
321
+
322
+ **Environment:**
323
+ - Python version: [X.Y.Z]
324
+ - Key dependencies: [pandas X.Y.Z, numpy X.Y.Z]
325
+ - Package manager: uv
326
+
327
+ **Reproduction Steps:**
328
+ 1. [Step 1]
329
+ 2. [Step 2]
330
+ 3. [Step 3]
331
+
332
+ **Expected Output:**
333
+ [Description of expected results if analysis is reproduced]
334
+
335
+ ---
336
+
337
+ **Report prepared by:** BioResearcher AI Agent
338
+ **Research completed:** [YYYY-MM-DD HH:MM]
339
+ **Report generated:** [YYYY-MM-DD HH:MM]
340
+ **Total sources cited:** [N]
341
+ ```
342
+
343
+ ---
344
+
345
+ ## Data Provenance Requirements
346
+
347
+ ### Rule 1: Every Claim Must Have Provenance
348
+
349
+ **Three options (at least one required):**
350
+
351
+ 1. **Citation** - Reference to bibliography [N]
352
+ 2. **Data Source** - Explicit mention of where data came from
353
+ 3. **Analysis Method** - How the conclusion was derived
354
+
355
+ ### Example: Proper vs. Improper Provenance
356
+
357
+ #### ❌ BAD: No Provenance
358
+ ```markdown
359
+ BRAF V600E is found in 50% of melanomas.
360
+ ```
361
+
362
+ #### ⚠️ ADEQUATE: Citation Only
363
+ ```markdown
364
+ BRAF V600E is found in approximately 50% of melanomas [1].
365
+ ```
366
+
367
+ #### ✅ GOOD: Complete Provenance
368
+ ```markdown
369
+ BRAF V600E mutations are found in approximately 50% of cutaneous melanomas
370
+ [1], based on analysis of 2,847 patient samples from the TCGA database
371
+ (query performed 2024-01-15, filter: primary melanoma, stage II-IV).
372
+
373
+ This finding is consistent with previous reports showing 40-60% prevalence
374
+ in this population [2, 3].
375
+ ```
376
+
377
+ ---
378
+
379
+ ## Citation Standards
380
+
381
+ ### In-Text Citation Format
382
+
383
+ **Single Source:**
384
+ ```markdown
385
+ BRAF V600E mutations are found in approximately 50% of melanomas [1].
386
+ ```
387
+
388
+ **Multiple Sources:**
389
+ ```markdown
390
+ Several studies have confirmed this association [1, 2, 3].
391
+ ```
392
+
393
+ **Range of Sources:**
394
+ ```markdown
395
+ This has been extensively documented [1-5].
396
+ ```
397
+
398
+ **Specific Claims:**
399
+ ```markdown
400
+ The drug was approved in 2011 [1] and has since become standard of care [2, 3].
401
+ ```
402
+
403
+ ### Bibliography Format by Source Type
404
+
405
+ #### Published Research
406
+ ```
407
+ [N] Author1 AB, Author2 CD, Author3 EF, et al. Article Title. Journal Name. Year;Volume(Issue):Pages. PMID: XXXXXXXX.
408
+ ```
409
+
410
+ **Example:**
411
+ ```
412
+ [1] Chapman PB, Hauschild A, Robert C, et al. Improved survival with vemurafenib in melanoma with BRAF V600E mutation. N Engl J Med. 2011;364(26):2507-2516. PMID: 21639808.
413
+ ```
414
+
415
+ #### Clinical Trials
416
+ ```
417
+ [N] NCT ID: Trial Title. Phase X. Sponsor: Company/Institution. Status: Recruiting/Completed. URL
418
+ ```
419
+
420
+ **Example:**
421
+ ```
422
+ [2] NCT04280705: A Study of Encorafenib Plus Cetuximab With or Without Nivolumab in Metastatic Colorectal Cancer. Phase 2. Sponsor: Pfizer. Status: Completed. https://clinicaltrials.gov/ct2/show/NCT04280705
423
+ ```
424
+
425
+ #### Web Sources
426
+ ```
427
+ [N] Page Title. Website Name. Published/Updated Date. URL. Accessed: YYYY-MM-DD.
428
+ ```
429
+
430
+ **Example:**
431
+ ```
432
+ [3] BRAF Gene. National Cancer Institute. Updated 2024. https://www.cancer.gov/about-cancer/causes-prevention/genetics/brca-genes. Accessed: 2024-01-15.
433
+ ```
434
+
435
+ #### Databases
436
+ ```
437
+ [N] Database Name. Version X.Y. Organization. Query: [SQL or search criteria]. Accessed: YYYY-MM-DD.
438
+ ```
439
+
440
+ **Example:**
441
+ ```
442
+ [4] ClinicalTrials.gov Database. U.S. National Library of Medicine. Query: "melanoma AND Phase 3 AND Recruiting". Accessed: 2024-01-15.
443
+ ```
444
+
445
+ #### Drug/Gene/Variant Information
446
+ ```
447
+ [N] Gene Symbol: Gene Name. Entrez ID: XXXXXX. HGNC ID: HGNC:XXXX. URL
448
+ ```
449
+
450
+ **Example:**
451
+ ```
452
+ [5] BRAF: B-Raf proto-oncogene, serine/threonine kinase. Entrez ID: 673. HGNC ID: HGNC:1097. https://www.ncbi.nlm.nih.gov/gene/673
453
+ ```
454
+
455
+ ---
456
+
457
+ ## Report Quality Checklist
458
+
459
+ Before finalizing report, verify:
460
+
461
+ ### Data Sources Section
462
+ - [ ] All data sources listed with types
463
+ - [ ] Access dates provided for all sources
464
+ - [ ] Queries/filters documented
465
+ - [ ] Data scope clearly defined
466
+ - [ ] Quality limitations noted
467
+
468
+ ### Analysis Methodology Section
469
+ - [ ] Analysis approach explained
470
+ - [ ] Decision rationale provided
471
+ - [ ] All tools/skills listed
472
+ - [ ] Step-by-step process documented
473
+ - [ ] Validation methods described
474
+
475
+ ### Findings Section
476
+ - [ ] All claims have citations
477
+ - [ ] Data provenance provided
478
+ - [ ] Confidence levels stated
479
+ - [ ] Supporting evidence included
480
+ - [ ] Tables/figures referenced
481
+
482
+ ### Limitations Section
483
+ - [ ] Data gaps acknowledged
484
+ - [ ] Methodological constraints noted
485
+ - [ ] Generalizability discussed
486
+
487
+ ### References Section
488
+ - [ ] All in-text citations in bibliography
489
+ - [ ] Format consistent by source type
490
+ - [ ] URLs/PMIDs/DOIs included
491
+ - [ ] Access dates for web sources
492
+ - [ ] Alphabetically numbered (not by author)
493
+
494
+ ### Appendix Section
495
+ - [ ] Raw data location provided
496
+ - [ ] Analysis code referenced
497
+ - [ ] Reproducibility notes included
498
+
499
+ ---
500
+
501
+ ## Template Usage Examples
502
+
503
+ ### Example 1: Literature Review Report
504
+
505
+ ```markdown
506
+ # BRAF V600E Mutation Prevalence in Melanoma
507
+
508
+ **Generated by:** BioResearcher AI Agent
509
+ **Date:** 2024-01-15
510
+ **Research Scope:** Systematic review of BRAF V600E mutation prevalence
511
+ in cutaneous melanoma across published studies
512
+
513
+ ---
514
+
515
+ ## Executive Summary
516
+
517
+ BRAF V600E mutations occur in approximately 50% of cutaneous melanomas
518
+ [1, 2], with prevalence varying by geographic region and melanoma subtype
519
+ [3]. This review analyzed 15 studies encompassing 8,247 patients.
520
+
521
+ **Key Findings:**
522
+ - Overall prevalence: 48-52% in cutaneous melanoma [1, 2, 3]
523
+ - Higher in chronic sun-damaged skin: 56% [4]
524
+ - Lower in acral melanoma: 15-20% [5]
525
+
526
+ [Continue with full template sections...]
527
+ ```
528
+
529
+ ### Example 2: Clinical Trial Analysis Report
530
+
531
+ ```markdown
532
+ # Phase 3 Melanoma Trials Analysis
533
+
534
+ **Generated by:** BioResearcher AI Agent
535
+ **Date:** 2024-01-15
536
+ **Research Scope:** Analysis of recruiting Phase 3 clinical trials for
537
+ melanoma treatments
538
+
539
+ ---
540
+
541
+ ## 1. Data Sources
542
+
543
+ ### 1.1 Primary Data Origin
544
+
545
+ **Source Type:** Database (ClinicalTrials.gov)
546
+
547
+ **Source Details:**
548
+
549
+ | Source | Type | Location/Query | Date Accessed |
550
+ |--------|------|----------------|---------------|
551
+ | ClinicalTrials.gov | Database | API + web scraping | 2024-01-15 |
552
+
553
+ **Data Scope:**
554
+ - **Records Retrieved:** 127 trials
555
+ - **Date Range:** 2000-2024
556
+ - **Filters Applied:** Phase 3, Melanoma, Recruiting
557
+ - **Sample Size:** 127 trials
558
+
559
+ [Continue with full template sections...]
560
+ ```
561
+
562
+ ---
563
+
564
+ ## Common Mistakes to Avoid
565
+
566
+ ### Mistake 1: Missing Data Provenance
567
+ ```
568
+ ❌ BAD: "Response rates were 65%"
569
+ ✅ GOOD: "Response rates were 65% [1] based on analysis of 42 Phase 3
570
+ trials from ClinicalTrials.gov (accessed 2024-01-15, filter:
571
+ melanoma AND recruiting)"
572
+ ```
573
+
574
+ ### Mistake 2: Incomplete Methodology
575
+ ```
576
+ ❌ BAD: "We analyzed the data"
577
+ ✅ GOOD: "Analysis was performed using tableGroupBy tool to aggregate
578
+ trials by phase, followed by custom Python statistical analysis
579
+ (.scripts/py/trial_statistics.py) to compare response rates"
580
+ ```
581
+
582
+ ### Mistake 3: Inconsistent Citations
583
+ ```
584
+ ❌ BAD: Mixed citation styles, missing PMIDs
585
+ ✅ GOOD: Consistent format by source type, all identifiers included
586
+ ```
587
+
588
+ ### Mistake 4: No Limitations Section
589
+ ```
590
+ ❌ BAD: Presenting findings as absolute truth
591
+ ✅ GOOD: Acknowledging data gaps, methodological constraints, and
592
+ generalizability limits
593
+ ```
594
+
595
+ ---
596
+
597
+ ## Report Review Process
598
+
599
+ ### Self-Review Checklist
600
+
601
+ 1. **Provenance Check:** Every claim has source citation or data origin
602
+ 2. **Citation Check:** All [N] references exist in bibliography
603
+ 3. **Format Check:** Bibliography follows source-type templates
604
+ 4. **Completeness Check:** All template sections present
605
+ 5. **Clarity Check:** Technical terms explained
606
+ 6. **Accuracy Check:** Numbers and statistics verified
607
+
608
+ ### Quality Standards
609
+
610
+ - **Transparency:** All methods and data sources documented
611
+ - **Reproducibility:** Another researcher could reproduce results
612
+ - **Credibility:** High-quality sources, proper citations
613
+ - **Professionalism:** Academic writing standards, clear structure