Skill Tracer
Skills › Scientific Agent Skills › literature-review › core_workflow.md

core_workflow.md

268 lines · skills/literature-review/references/core_workflow.md at 5f2bc03

Open on GitHub

Most marks come from matching words in the file, so treat them as pointers.

1# Core Workflow
2
3Illustrative workflow; example queries, dates, counts, and numerical findings are not executed review results. Run commands from this skill directory, using paths to your review workspace.
4
5All seven phases in full: planning and scoping, systematic search, screening and
6selection, data extraction and quality assessment, synthesis and analysis, citation
7verification, and document generation.
8

Core Workflow

Illustrative workflow; example queries, dates, counts, and numerical findings are not executed review results. Run commands from this skill directory, using paths to your review workspace.

All seven phases in full: planning and scoping, systematic search, screening and selection, data extraction and quality assessment, synthesis and analysis, citation verification, and document generation.

Raw lines 1 to 8
9## Core Workflow
11Literature reviews follow a structured, multi-phase workflow:

Core Workflow

Literature reviews follow a structured, multi-phase workflow:

Raw lines 9 to 12
13### Phase 1: Planning and Scoping
151. **Define Research Question**: Use PICO framework (Population, Intervention, Comparison, Outcome) for clinical/biomedical reviews
16 - Example: "What is the efficacy of CRISPR-Cas9 (I) for treating sickle cell disease (P) compared to standard care (C)?"
182. **Establish Scope and Objectives**:
19 - Define clear, specific research questions
20 - Determine review type (narrative, systematic, scoping, meta-analysis)
21 - Set boundaries (time period, geographic scope, study types)
233. **Develop Search Strategy**:
24 - Identify 2-4 main concepts from research question
25 - List synonyms, abbreviations, and related terms for each concept
26 - Plan Boolean operators (AND, OR, NOT) to combine terms
27 - Select complementary bibliographic databases and registries appropriate to the question
28 - **Optionally use parallel-web (`parallel-cli search`) for initial scoping** to quickly gauge the landscape before formal database searches
304. **Set Inclusion/Exclusion Criteria**:
31 - Date range (e.g., the explicitly historical interval 2015-2024)
32 - Language (typically English, or specify multilingual)
33 - Publication types (peer-reviewed, preprints, reviews)
34 - Study designs (RCTs, observational, in vitro, etc.)
35 - Document all criteria clearly

Phase 1: Planning and Scoping

  1. Define Research Question: Use PICO framework (Population, Intervention, Comparison, Outcome) for clinical/biomedical reviews
  2. Example: "What is the efficacy of CRISPR-Cas9 (I) for treating sickle cell disease (P) compared to standard care (C)?"
  1. Establish Scope and Objectives:
  2. Define clear, specific research questions
  3. Determine review type (narrative, systematic, scoping, meta-analysis)
  4. Set boundaries (time period, geographic scope, study types)
  1. Develop Search Strategy:
  2. Identify 2-4 main concepts from research question
  3. List synonyms, abbreviations, and related terms for each concept
  4. Plan Boolean operators (AND, OR, NOT) to combine terms
  5. Select complementary bibliographic databases and registries appropriate to the question
  6. **Optionally use parallel-web (parallel-cli search) for initial scoping** to quickly gauge the landscape before formal database searches
  1. Set Inclusion/Exclusion Criteria:
  2. Date range (e.g., the explicitly historical interval 2015-2024)
  3. Language (typically English, or specify multilingual)
  4. Publication types (peer-reviewed, preprints, reviews)
  5. Study designs (RCTs, observational, in vitro, etc.)
  6. Document all criteria clearly
Raw lines 13 to 36
37### Phase 2: Systematic Literature Search
391. **Multi-Database Search**:
41 Select bibliographic databases and registries appropriate for the domain. Use optional web search for scoping and supplementary discovery; record it separately from database exports.
43 **Supplementary web discovery (parallel-web):**
44 - Use `parallel-cli search` with academic domain filtering for broad scholarly coverage
45 - Consider academic-focused and general searches; ranked samples do not guarantee complete retrieval
46 ```bash
47 mkdir -p sources
48 # Illustrative ranked sample; not a complete search
49 parallel-cli search "your research topic" -q "keyword1" -q "keyword2" \
50 --json --max-results 10 --excerpt-max-chars-total 27000 \
51 --include-domains "scholar.google.com,arxiv.org,pubmed.ncbi.nlm.nih.gov,semanticscholar.org,biorxiv.org,medrxiv.org,ncbi.nlm.nih.gov,nature.com,science.org,ieee.org,acm.org,springer.com,wiley.com,cell.com,pnas.org,nih.gov" \
52 -o sources/litreview_<topic>-academic.json
54 # General search for supplementary sources
55 parallel-cli search "your research topic" -q "keyword1" -q "keyword2" \
56 --json --max-results 10 --excerpt-max-chars-total 27000 \
57 -o sources/litreview_<topic>-general.json
58 ```
59 - Use `parallel-cli extract --full-content` to request content from accessible paper URLs; check for truncation and retrieval errors
60 ```bash
61 parallel-cli extract "https://arxiv.org/abs/1706.03762" --full-content --json
62 ```
64 **Biomedical & Life Sciences:**
65 - Search PubMed via its interface or E-utilities; PMC has different full-text coverage
66 - Search bioRxiv/medRxiv interfaces, or retrieve date-range API metadata and explicitly filter it
67 - See `database_strategies.md` for exact requests, authentication, and export limits
69 **General Scientific Literature:**
70 - Search arXiv via direct API (preprints in physics, math, CS, q-bio)
71 - Search Semantic Scholar using its documented relevance or bulk API as appropriate
72 - Use Google Scholar manually for supplementary discovery and citation chaining; preserve search and screening limits
74 Biological entity databases can inform background, but do not count as
75 bibliographic sources simply because they contain references.
772. **Document Search Parameters**:
78 ```markdown
79 ## Search Strategy
81 ### Database: PubMed
82 - **Date searched**: 2024-10-25
83 - **Date range**: 2015-01-01 to 2024-10-25
84 - **Search string**:
85 ```
86 ("CRISPR"[Title] OR "Cas9"[Title])
87 AND ("Anemia, Sickle Cell"[MeSH Terms] OR "SCD"[Title/Abstract])
88 AND 2015:2024[Publication Date]
89 ```
90 - **Results**: 247 articles
91 ```
93 Repeat for each database searched.
953. **Export and Aggregate Results**:
96 - Export results in JSON format from each database
97 - Normalize raw provider responses into a JSON array, preserving raw exports and provenance separately
98 - Use `scripts/search_databases.py` for post-processing:
99 ```bash
100 python scripts/search_databases.py combined_results.json \
101 --deduplicate \
102 --format markdown \
103 --output aggregated_results.md
104 ```

Phase 2: Systematic Literature Search

  1. Multi-Database Search:

Select bibliographic databases and registries appropriate for the domain. Use optional web search for scoping and supplementary discovery; record it separately from database exports.

Supplementary web discovery (parallel-web):

  • Use parallel-cli search with academic domain filtering for broad scholarly coverage
  • Consider academic-focused and general searches; ranked samples do not guarantee complete retrieval ```bash mkdir -p sources # Illustrative ranked sample; not a complete search parallel-cli search "your research topic" -q "keyword1" -q "keyword2" \ --json --max-results 10 --excerpt-max-chars-total 27000 \ --include-domains "scholar.google.com,arxiv.org,pubmed.ncbi.nlm.nih.gov,semanticscholar.org,biorxiv.org,medrxiv.org,ncbi.nlm.nih.gov,nature.com,science.org,ieee.org,acm.org,springer.com,wiley.com,cell.com,pnas.org,nih.gov" \ -o sources/litreview_<topic>-academic.json

# General search for supplementary sources parallel-cli search "your research topic" -q "keyword1" -q "keyword2" \ --json --max-results 10 --excerpt-max-chars-total 27000 \ -o sources/litreview_<topic>-general.json ```

  • Use parallel-cli extract --full-content to request content from accessible paper URLs; check for truncation and retrieval errors ``bash parallel-cli extract "https://arxiv.org/abs/1706.03762" --full-content --json

Biomedical & Life Sciences:

  • Search PubMed via its interface or E-utilities; PMC has different full-text coverage
  • Search bioRxiv/medRxiv interfaces, or retrieve date-range API metadata and explicitly filter it
  • See database_strategies.md for exact requests, authentication, and export limits

General Scientific Literature:

  • Search arXiv via direct API (preprints in physics, math, CS, q-bio)
  • Search Semantic Scholar using its documented relevance or bulk API as appropriate
  • Use Google Scholar manually for supplementary discovery and citation chaining; preserve search and screening limits

Biological entity databases can inform background, but do not count as bibliographic sources simply because they contain references.

  1. Document Search Parameters: ```markdown ## Search Strategy

### Database: PubMed

  • Date searched: 2024-10-25
  • Date range: 2015-01-01 to 2024-10-25
  • Search string: `` ("CRISPR"[Title] OR "Cas9"[Title]) AND ("Anemia, Sickle Cell"[MeSH Terms] OR "SCD"[Title/Abstract]) AND 2015:2024[Publication Date]
  • Results: 247 articles ```

Repeat for each database searched.

  1. Export and Aggregate Results:
  2. Export results in JSON format from each database
  3. Normalize raw provider responses into a JSON array, preserving raw exports and provenance separately
  4. Use scripts/search_databases.py for post-processing: ``bash python scripts/search_databases.py combined_results.json \ --deduplicate \ --format markdown \ --output aggregated_results.md
Raw lines 37 to 105
Runs code scripts/search_databases.py :98
Runs code python scripts/search_databases.py :100
106### Phase 3: Screening and Selection
1081. **Deduplication**:
109 ```bash
110 python scripts/search_databases.py results.json --deduplicate --format json --output unique_results.json
111 ```
112 - Keeps first normalized DOI; title fallback compares DOI-less records only. Review matches and retain raw duplicates for enrichment
113 - Document number of duplicates removed
1152. **Title Screening**:
116 - Review all titles against inclusion/exclusion criteria
117 - Exclude obviously irrelevant studies
118 - Document number excluded at this stage
1203. **Abstract Screening**:
121 - Read abstracts of remaining studies
122 - Apply inclusion/exclusion criteria rigorously
123 - Document reasons for exclusion
1254. **Full-Text Screening**:
126 - Obtain full texts of remaining studies
127 - Conduct detailed review against all criteria
128 - Document specific reasons for exclusion
129 - Record final number of included studies
1315. **Create PRISMA Flow Diagram**:
132 - Use the official template matching new/updated review and source types.
133 - Track records identified and removed before screening, records screened
134 and excluded, reports sought/not retrieved/assessed, excluded reports with
135 reasons, and included studies plus reports of those studies.
136 - Reconcile counts at each transition; do not invent one included-study count
137 from the number of publications. Maintain a study-to-report map.

Phase 3: Screening and Selection

  1. Deduplication: ``bash python scripts/search_databases.py results.json --deduplicate --format json --output unique_results.json
  2. Keeps first normalized DOI; title fallback compares DOI-less records only. Review matches and retain raw duplicates for enrichment
  3. Document number of duplicates removed
  1. Title Screening:
  2. Review all titles against inclusion/exclusion criteria
  3. Exclude obviously irrelevant studies
  4. Document number excluded at this stage
  1. Abstract Screening:
  2. Read abstracts of remaining studies
  3. Apply inclusion/exclusion criteria rigorously
  4. Document reasons for exclusion
  1. Full-Text Screening:
  2. Obtain full texts of remaining studies
  3. Conduct detailed review against all criteria
  4. Document specific reasons for exclusion
  5. Record final number of included studies
  1. Create PRISMA Flow Diagram:
  2. Use the official template matching new/updated review and source types.
  3. Track records identified and removed before screening, records screened and excluded, reports sought/not retrieved/assessed, excluded reports with reasons, and included studies plus reports of those studies.
  4. Reconcile counts at each transition; do not invent one included-study count from the number of publications. Maintain a study-to-report map.
Raw lines 106 to 138
Runs code python scripts/search_databases.py :110
139### Phase 4: Data Extraction and Quality Assessment
1411. **Extract Key Data** from each included study:
142 - Study metadata (authors, year, journal, DOI)
143 - Study design and methods
144 - Sample size and population characteristics
145 - Key findings and results
146 - Limitations noted by authors
147 - Funding sources and conflicts of interest
1492. **Assess Risk of Bias and Certainty**:
150 - Use a tool appropriate to the design and question: RoB 2 for randomized
151 trial results; ROBINS-I for nonrandomized intervention results; AMSTAR 2
152 for systematic reviews of healthcare interventions. Other designs require their own appraisal tool.
153 - Preserve domain judgments and rationale. RoB 2 uses low risk, some concerns,
154 or high risk; do not force every tool onto a common numerical scale.
155 - GRADE assesses a body of evidence for each outcome (high/moderate/low/very
156 low), not a generic grade for each individual study. See the
157 [Cochrane certainty guidance](https://www.cochrane.org/authors/handbooks-and-manuals/handbook/current/chapter-14).
158 - Pre-specify how bias affects synthesis; do not invent post-hoc exclusions.
1603. **Organize by Themes**:
161 - Identify 3-5 major themes across studies
162 - Group studies by theme (studies may appear in multiple themes)
163 - Note patterns, consensus, and controversies

Phase 4: Data Extraction and Quality Assessment

  1. Extract Key Data from each included study:
  2. Study metadata (authors, year, journal, DOI)
  3. Study design and methods
  4. Sample size and population characteristics
  5. Key findings and results
  6. Limitations noted by authors
  7. Funding sources and conflicts of interest
  1. Assess Risk of Bias and Certainty:
  2. Use a tool appropriate to the design and question: RoB 2 for randomized trial results; ROBINS-I for nonrandomized intervention results; AMSTAR 2 for systematic reviews of healthcare interventions. Other designs require their own appraisal tool.
  3. Preserve domain judgments and rationale. RoB 2 uses low risk, some concerns, or high risk; do not force every tool onto a common numerical scale.
  4. GRADE assesses a body of evidence for each outcome (high/moderate/low/very low), not a generic grade for each individual study. See the Cochrane certainty guidance.
  5. Pre-specify how bias affects synthesis; do not invent post-hoc exclusions.
  1. Organize by Themes:
  2. Identify 3-5 major themes across studies
  3. Group studies by theme (studies may appear in multiple themes)
  4. Note patterns, consensus, and controversies
Raw lines 139 to 164
165### Phase 5: Synthesis and Analysis
1671. **Create Review Document** from template:
168 ```bash
169 cp assets/review_template.md my_literature_review.md
170 ```
1722. **Write Thematic Synthesis** (NOT study-by-study summaries):
173 - Organize Results section by themes or research questions
174 - Synthesize findings across multiple studies within each theme
175 - Compare and contrast different approaches and results
176 - Identify consensus areas and points of controversy
177 - Highlight the strongest evidence
179 Fictitious structure example (replace every count and percentage with extracted evidence):
180 ```markdown
181 #### 3.3.1 Theme: CRISPR Delivery Methods
183 Multiple delivery approaches have been investigated for therapeutic
184 gene editing. Viral vectors (AAV) were used in 15 studies^1-15^ and
185 showed high transduction efficiency (65-85%) but raised immunogenicity
186 concerns^3,7,12^. In contrast, lipid nanoparticles demonstrated lower
187 efficiency (40-60%) but improved safety profiles^16-23^.
188 ```
1903. **Critical Analysis**:
191 - Evaluate methodological strengths and limitations across studies
192 - Assess quality and consistency of evidence
193 - Identify knowledge gaps and methodological gaps
194 - Note areas requiring future research
1964. **Write Discussion**:
197 - Interpret findings in broader context
198 - Discuss clinical, practical, or research implications
199 - Acknowledge limitations of the review itself
200 - Compare with previous reviews if applicable
201 - Propose specific future research directions

Phase 5: Synthesis and Analysis

  1. Create Review Document from template: ``bash cp assets/review_template.md my_literature_review.md
  1. Write Thematic Synthesis (NOT study-by-study summaries):
  2. Organize Results section by themes or research questions
  3. Synthesize findings across multiple studies within each theme
  4. Compare and contrast different approaches and results
  5. Identify consensus areas and points of controversy
  6. Highlight the strongest evidence

Fictitious structure example (replace every count and percentage with extracted evidence): ```markdown #### 3.3.1 Theme: CRISPR Delivery Methods

Multiple delivery approaches have been investigated for therapeutic gene editing. Viral vectors (AAV) were used in 15 studies^1-15^ and showed high transduction efficiency (65-85%) but raised immunogenicity concerns^3,7,12^. In contrast, lipid nanoparticles demonstrated lower efficiency (40-60%) but improved safety profiles^16-23^. ```

  1. Critical Analysis:
  2. Evaluate methodological strengths and limitations across studies
  3. Assess quality and consistency of evidence
  4. Identify knowledge gaps and methodological gaps
  5. Note areas requiring future research
  1. Write Discussion:
  2. Interpret findings in broader context
  3. Discuss clinical, practical, or research implications
  4. Acknowledge limitations of the review itself
  5. Compare with previous reviews if applicable
  6. Propose specific future research directions
Raw lines 165 to 202
203### Phase 6: Citation Verification
205**CRITICAL**: All citations must be verified for accuracy before final submission.
2071. **Verify All DOIs**:
208 ```bash
209 python scripts/verify_citations.py my_literature_review.md
210 ```
212 This script:
213 - Extracts all DOIs from the document
214 - Checks DOI registration via the Handle API
215 - Retrieves available Crossref metadata and preserves unresolved errors
216 - Generates verification report
217 - Does not verify claim support, publisher accessibility, or final citation style
2192. **Review Verification Report**:
220 - Check for any failed DOIs
221 - Verify author names, titles, and publication details match
222 - Correct any errors in the original document
223 - Resolve errors against the source; do not delete a reference solely because a service timed out or lacks its metadata
2253. **Format Citations Consistently**:
226 - Choose one citation style and use throughout (see `references/citation_styles.md`)
227 - Common styles: APA, Nature, Vancouver, Chicago, IEEE
228 - Use complete metadata with a CSL processor; the script only provides metadata previews
229 - Ensure in-text citations match reference list format

Phase 6: Citation Verification

CRITICAL: All citations must be verified for accuracy before final submission.

  1. Verify All DOIs: ``bash python scripts/verify_citations.py my_literature_review.md

This script:

  • Extracts all DOIs from the document
  • Checks DOI registration via the Handle API
  • Retrieves available Crossref metadata and preserves unresolved errors
  • Generates verification report
  • Does not verify claim support, publisher accessibility, or final citation style
  1. Review Verification Report:
  2. Check for any failed DOIs
  3. Verify author names, titles, and publication details match
  4. Correct any errors in the original document
  5. Resolve errors against the source; do not delete a reference solely because a service timed out or lacks its metadata
  1. Format Citations Consistently:
  2. Choose one citation style and use throughout (see references/citation_styles.md)
  3. Common styles: APA, Nature, Vancouver, Chicago, IEEE
  4. Use complete metadata with a CSL processor; the script only provides metadata previews
  5. Ensure in-text citations match reference list format
Raw lines 203 to 230
Runs code python scripts/verify_citations.py :209
231### Phase 7: Document Generation
2331. **Generate PDF**:
234 ```bash
235 python scripts/generate_pdf.py my_literature_review.md \
236 --bibliography my_literature_review.bib --csl styles/apa.csl \
237 --output my_review.pdf
238 ```
240 Supply an existing `.bib` and `.csl` for that example; they are not bundled.
241 `[@key]` citations are formatted, while manually typed references remain unchanged.
243 Options:
244 - `--csl` / `--citation-style`: existing local CSL path/name; omitted uses Pandoc default
245 - `--bibliography`: bibliography file; sibling `.bib` also auto-detected
246 - `--output`: PDF destination
247 - `--no-toc`: Disable table of contents
248 - `--no-numbers`: Disable section numbering
249 - `--check-deps`: Check if pandoc/xelatex are installed
2512. **Review Final Output**:
252 - Check PDF formatting and layout
253 - Verify all sections are present
254 - Ensure citations render correctly
255 - Check that figures/tables appear properly
256 - Verify table of contents is accurate
2583. **Quality Checklist**:
259 - [ ] DOI registration checked; metadata identity and claim support reviewed manually
260 - [ ] Citations formatted consistently
261 - [ ] PRISMA flow diagram included (for systematic reviews)
262 - [ ] Search methodology fully documented
263 - [ ] Inclusion/exclusion criteria clearly stated
264 - [ ] Results organized thematically (not study-by-study)
265 - [ ] Quality assessment completed
266 - [ ] Limitations acknowledged
267 - [ ] References complete and accurate
268 - [ ] PDF generates without errors

Phase 7: Document Generation

  1. Generate PDF: ``bash python scripts/generate_pdf.py my_literature_review.md \ --bibliography my_literature_review.bib --csl styles/apa.csl \ --output my_review.pdf

Supply an existing .bib and .csl for that example; they are not bundled. [@key] citations are formatted, while manually typed references remain unchanged.

Options:

  • --csl / --citation-style: existing local CSL path/name; omitted uses Pandoc default
  • --bibliography: bibliography file; sibling .bib also auto-detected
  • --output: PDF destination
  • --no-toc: Disable table of contents
  • --no-numbers: Disable section numbering
  • --check-deps: Check if pandoc/xelatex are installed
  1. Review Final Output:
  2. Check PDF formatting and layout
  3. Verify all sections are present
  4. Ensure citations render correctly
  5. Check that figures/tables appear properly
  6. Verify table of contents is accurate
  1. Quality Checklist:
  2. [ ] DOI registration checked; metadata identity and claim support reviewed manually
  3. [ ] Citations formatted consistently
  4. [ ] PRISMA flow diagram included (for systematic reviews)
  5. [ ] Search methodology fully documented
  6. [ ] Inclusion/exclusion criteria clearly stated
  7. [ ] Results organized thematically (not study-by-study)
  8. [ ] Quality assessment completed
  9. [ ] Limitations acknowledged
  10. [ ] References complete and accurate
  11. [ ] PDF generates without errors
Raw lines 231 to 268
Runs code python scripts/generate_pdf.py :235