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

example_workflow.md

71 lines · skills/literature-review/references/example_workflow.md at 5f2bc03

Open on GitHub

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

1# Example Workflow
2
3Illustrative end-to-end recipe, not an executed review. Run from the skill directory; populate the protocol, normalized search records, bibliography, and CSL file before the dependent commands. Dates below are a deliberately historical 2015-2024 interval.
4

Example Workflow

Illustrative end-to-end recipe, not an executed review. Run from the skill directory; populate the protocol, normalized search records, bibliography, and CSL file before the dependent commands. Dates below are a deliberately historical 2015-2024 interval.

Raw lines 1 to 4
5## Example Workflow
6
7Complete workflow for a biomedical literature review:
8
9```bash
10# 1. Create review document from template
11mkdir -p sources styles
12cp assets/review_template.md crispr_sickle_cell_review.md
14# 2. Optional supplementary discovery (authenticated Parallel account)
15parallel-cli search "CRISPR Cas9 sickle cell disease gene therapy efficacy" \
16 -q "CRISPR" -q "sickle cell" -q "gene therapy" \
17 --json --max-results 10 --excerpt-max-chars-total 27000 \
18 --include-domains "scholar.google.com,arxiv.org,pubmed.ncbi.nlm.nih.gov,semanticscholar.org,biorxiv.org,nature.com,science.org,cell.com,pnas.org,nih.gov" \
19 -o sources/litreview_crispr_scd-academic.json
21parallel-cli search "CRISPR sickle cell disease clinical trials treatment" \
22 -q "CRISPR" -q "sickle cell" \
23 --json --max-results 10 --excerpt-max-chars-total 27000 \
24 -o sources/litreview_crispr_scd-general.json
26# 3. Search specialized databases using appropriate skills
27# - Use PubMed E-utilities and bioRxiv/medRxiv search or date-metadata APIs
28# - Use direct API access for arXiv, Semantic Scholar
29# - Save all pages and counts; document any API caps or failed requests
30# - Normalize into a JSON array; keep raw exports and provenance
32# 4. Process your normalized combined_results.json; raw API envelopes will fail
33python scripts/search_databases.py combined_results.json \
34 --deduplicate \
35 --year-start 2015 \
36 --year-end 2024 \
37 --format markdown \
38 --output search_results.md \
39 --summary
41# 5. Screen results and extract data
42# - Request extracts with --full-content; obtain original reports and record failures
43# - Use independent final full-text decisions and retain exclusion reasons
44# - Track records, reports, studies, and overlapping participants separately
45# - Extract key data into the review document
46# - Organize by themes
48# 6. Write the review following template structure
49# - Introduction with clear objectives
50# - Detailed methodology section
51# - Results organized thematically
52# - Critical discussion
53# - Clear conclusions
55# 7. Check DOI registration/metadata, then manually verify identity and claim support
56python scripts/verify_citations.py crispr_sickle_cell_review.md
58# Review the citation report
59cat crispr_sickle_cell_review_citation_report.json
61# Investigate missing/inconclusive results; transient failures do not invalidate citations
62python scripts/verify_citations.py crispr_sickle_cell_review.md
64# 8. Render after supplying bibliography, local CSL, and [@key] citations
65# For manually typed references, omit those options; text will not be restyled
66python scripts/generate_pdf.py crispr_sickle_cell_review.md \
67 --bibliography crispr_sickle_cell_review.bib --csl styles/nature.csl \
68 --output crispr_sickle_cell_review.pdf
70# 9. Review final PDF and markdown outputs
71```

Example Workflow

Complete workflow for a biomedical literature review:

# 1. Create review document from template
mkdir -p sources styles
cp assets/review_template.md crispr_sickle_cell_review.md

# 2. Optional supplementary discovery (authenticated Parallel account)
parallel-cli search "CRISPR Cas9 sickle cell disease gene therapy efficacy" \
  -q "CRISPR" -q "sickle cell" -q "gene therapy" \
  --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,nature.com,science.org,cell.com,pnas.org,nih.gov" \
  -o sources/litreview_crispr_scd-academic.json

parallel-cli search "CRISPR sickle cell disease clinical trials treatment" \
  -q "CRISPR" -q "sickle cell" \
  --json --max-results 10 --excerpt-max-chars-total 27000 \
  -o sources/litreview_crispr_scd-general.json

# 3. Search specialized databases using appropriate skills
# - Use PubMed E-utilities and bioRxiv/medRxiv search or date-metadata APIs
# - Use direct API access for arXiv, Semantic Scholar
# - Save all pages and counts; document any API caps or failed requests
# - Normalize into a JSON array; keep raw exports and provenance

# 4. Process your normalized combined_results.json; raw API envelopes will fail
python scripts/search_databases.py combined_results.json \
  --deduplicate \
  --year-start 2015 \
  --year-end 2024 \
  --format markdown \
  --output search_results.md \
  --summary

# 5. Screen results and extract data
# - Request extracts with --full-content; obtain original reports and record failures
# - Use independent final full-text decisions and retain exclusion reasons
# - Track records, reports, studies, and overlapping participants separately
# - Extract key data into the review document
# - Organize by themes

# 6. Write the review following template structure
# - Introduction with clear objectives
# - Detailed methodology section
# - Results organized thematically
# - Critical discussion
# - Clear conclusions

# 7. Check DOI registration/metadata, then manually verify identity and claim support
python scripts/verify_citations.py crispr_sickle_cell_review.md

# Review the citation report
cat crispr_sickle_cell_review_citation_report.json

# Investigate missing/inconclusive results; transient failures do not invalidate citations
python scripts/verify_citations.py crispr_sickle_cell_review.md

# 8. Render after supplying bibliography, local CSL, and [@key] citations
# For manually typed references, omit those options; text will not be restyled
python scripts/generate_pdf.py crispr_sickle_cell_review.md \
  --bibliography crispr_sickle_cell_review.bib --csl styles/nature.csl \
  --output crispr_sickle_cell_review.pdf

# 9. Review final PDF and markdown outputs
Raw lines 5 to 71
Runs code python scripts/search_databases.py :33
Runs code python scripts/verify_citations.py :56
Runs code python scripts/generate_pdf.py :66