@wentorai/research-plugins 1.0.0
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/LICENSE +21 -0
- package/README.md +204 -0
- package/curated/analysis/README.md +64 -0
- package/curated/domains/README.md +104 -0
- package/curated/literature/README.md +53 -0
- package/curated/research/README.md +62 -0
- package/curated/tools/README.md +87 -0
- package/curated/writing/README.md +61 -0
- package/index.ts +39 -0
- package/mcp-configs/academic-db/ChatSpatial.json +17 -0
- package/mcp-configs/academic-db/academia-mcp.json +17 -0
- package/mcp-configs/academic-db/academic-paper-explorer.json +17 -0
- package/mcp-configs/academic-db/academic-search-mcp-server.json +17 -0
- package/mcp-configs/academic-db/agentinterviews-mcp.json +17 -0
- package/mcp-configs/academic-db/all-in-mcp.json +17 -0
- package/mcp-configs/academic-db/apple-health-mcp.json +17 -0
- package/mcp-configs/academic-db/arxiv-latex-mcp.json +17 -0
- package/mcp-configs/academic-db/arxiv-mcp-server.json +17 -0
- package/mcp-configs/academic-db/bgpt-mcp.json +17 -0
- package/mcp-configs/academic-db/biomcp.json +17 -0
- package/mcp-configs/academic-db/biothings-mcp.json +17 -0
- package/mcp-configs/academic-db/catalysishub-mcp-server.json +17 -0
- package/mcp-configs/academic-db/clinicaltrialsgov-mcp-server.json +17 -0
- package/mcp-configs/academic-db/deep-research-mcp.json +17 -0
- package/mcp-configs/academic-db/dicom-mcp.json +17 -0
- package/mcp-configs/academic-db/enrichr-mcp-server.json +17 -0
- package/mcp-configs/academic-db/fec-mcp-server.json +17 -0
- package/mcp-configs/academic-db/fhir-mcp-server-themomentum.json +17 -0
- package/mcp-configs/academic-db/fhir-mcp.json +19 -0
- package/mcp-configs/academic-db/gget-mcp.json +17 -0
- package/mcp-configs/academic-db/google-researcher-mcp.json +17 -0
- package/mcp-configs/academic-db/idea-reality-mcp.json +17 -0
- package/mcp-configs/academic-db/legiscan-mcp.json +19 -0
- package/mcp-configs/academic-db/lex.json +17 -0
- package/mcp-configs/ai-platform/Adaptive-Graph-of-Thoughts-MCP-server.json +17 -0
- package/mcp-configs/ai-platform/ai-counsel.json +17 -0
- package/mcp-configs/ai-platform/atlas-mcp-server.json +17 -0
- package/mcp-configs/ai-platform/counsel-mcp.json +17 -0
- package/mcp-configs/ai-platform/cross-llm-mcp.json +17 -0
- package/mcp-configs/ai-platform/gptr-mcp.json +17 -0
- package/mcp-configs/browser/decipher-research-agent.json +17 -0
- package/mcp-configs/browser/deep-research.json +17 -0
- package/mcp-configs/browser/everything-claude-code.json +17 -0
- package/mcp-configs/browser/gpt-researcher.json +17 -0
- package/mcp-configs/browser/heurist-agent-framework.json +17 -0
- package/mcp-configs/data-platform/4everland-hosting-mcp.json +17 -0
- package/mcp-configs/data-platform/context-keeper.json +17 -0
- package/mcp-configs/data-platform/context7.json +19 -0
- package/mcp-configs/data-platform/contextstream-mcp.json +17 -0
- package/mcp-configs/data-platform/email-mcp.json +17 -0
- package/mcp-configs/note-knowledge/ApeRAG.json +17 -0
- package/mcp-configs/note-knowledge/In-Memoria.json +17 -0
- package/mcp-configs/note-knowledge/agent-memory.json +17 -0
- package/mcp-configs/note-knowledge/aimemo.json +17 -0
- package/mcp-configs/note-knowledge/biel-mcp.json +19 -0
- package/mcp-configs/note-knowledge/cognee.json +17 -0
- package/mcp-configs/note-knowledge/context-awesome.json +17 -0
- package/mcp-configs/note-knowledge/context-mcp.json +17 -0
- package/mcp-configs/note-knowledge/conversation-handoff-mcp.json +17 -0
- package/mcp-configs/note-knowledge/cortex.json +17 -0
- package/mcp-configs/note-knowledge/devrag.json +17 -0
- package/mcp-configs/note-knowledge/easy-obsidian-mcp.json +17 -0
- package/mcp-configs/note-knowledge/engram.json +17 -0
- package/mcp-configs/note-knowledge/gnosis-mcp.json +17 -0
- package/mcp-configs/note-knowledge/graphlit-mcp-server.json +19 -0
- package/mcp-configs/reference-mgr/arxiv-cli.json +17 -0
- package/mcp-configs/reference-mgr/arxiv-search-mcp.json +17 -0
- package/mcp-configs/reference-mgr/chiken.json +17 -0
- package/mcp-configs/reference-mgr/claude-scholar.json +17 -0
- package/mcp-configs/reference-mgr/devonthink-mcp.json +17 -0
- package/mcp-configs/registry.json +447 -0
- package/openclaw.plugin.json +21 -0
- package/package.json +61 -0
- package/skills/analysis/dataviz/color-accessibility-guide/SKILL.md +230 -0
- package/skills/analysis/dataviz/geospatial-viz-guide/SKILL.md +218 -0
- package/skills/analysis/dataviz/interactive-viz-guide/SKILL.md +287 -0
- package/skills/analysis/dataviz/network-visualization-guide/SKILL.md +195 -0
- package/skills/analysis/dataviz/publication-figures-guide/SKILL.md +238 -0
- package/skills/analysis/dataviz/python-dataviz-guide/SKILL.md +195 -0
- package/skills/analysis/econometrics/causal-inference-guide/SKILL.md +197 -0
- package/skills/analysis/econometrics/iv-regression-guide/SKILL.md +198 -0
- package/skills/analysis/econometrics/panel-data-guide/SKILL.md +274 -0
- package/skills/analysis/econometrics/robustness-checks/SKILL.md +250 -0
- package/skills/analysis/econometrics/stata-regression/SKILL.md +117 -0
- package/skills/analysis/econometrics/time-series-guide/SKILL.md +235 -0
- package/skills/analysis/statistics/bayesian-statistics-guide/SKILL.md +221 -0
- package/skills/analysis/statistics/hypothesis-testing-guide/SKILL.md +210 -0
- package/skills/analysis/statistics/meta-analysis-guide/SKILL.md +206 -0
- package/skills/analysis/statistics/nonparametric-tests-guide/SKILL.md +221 -0
- package/skills/analysis/statistics/power-analysis-guide/SKILL.md +240 -0
- package/skills/analysis/statistics/sem-guide/SKILL.md +231 -0
- package/skills/analysis/statistics/survival-analysis-guide/SKILL.md +195 -0
- package/skills/analysis/wrangling/missing-data-handling/SKILL.md +224 -0
- package/skills/analysis/wrangling/pandas-data-wrangling/SKILL.md +242 -0
- package/skills/analysis/wrangling/questionnaire-design-guide/SKILL.md +234 -0
- package/skills/analysis/wrangling/text-mining-guide/SKILL.md +225 -0
- package/skills/domains/ai-ml/computer-vision-guide/SKILL.md +213 -0
- package/skills/domains/ai-ml/deep-learning-papers-guide/SKILL.md +200 -0
- package/skills/domains/ai-ml/llm-evaluation-guide/SKILL.md +194 -0
- package/skills/domains/ai-ml/prompt-engineering-research/SKILL.md +233 -0
- package/skills/domains/ai-ml/reinforcement-learning-guide/SKILL.md +254 -0
- package/skills/domains/ai-ml/transformer-architecture-guide/SKILL.md +233 -0
- package/skills/domains/biomedical/clinical-research-guide/SKILL.md +232 -0
- package/skills/domains/biomedical/clinicaltrials-api/SKILL.md +177 -0
- package/skills/domains/biomedical/epidemiology-guide/SKILL.md +200 -0
- package/skills/domains/biomedical/genomics-analysis-guide/SKILL.md +270 -0
- package/skills/domains/business/market-analysis-guide/SKILL.md +112 -0
- package/skills/domains/business/strategic-management-guide/SKILL.md +154 -0
- package/skills/domains/chemistry/computational-chemistry-guide/SKILL.md +266 -0
- package/skills/domains/chemistry/retrosynthesis-guide/SKILL.md +215 -0
- package/skills/domains/cs/algorithms-complexity-guide/SKILL.md +194 -0
- package/skills/domains/cs/dblp-api/SKILL.md +129 -0
- package/skills/domains/cs/software-engineering-research/SKILL.md +218 -0
- package/skills/domains/ecology/biodiversity-data-guide/SKILL.md +296 -0
- package/skills/domains/ecology/conservation-biology-guide/SKILL.md +198 -0
- package/skills/domains/ecology/gbif-api/SKILL.md +158 -0
- package/skills/domains/ecology/inaturalist-api/SKILL.md +173 -0
- package/skills/domains/economics/behavioral-economics-guide/SKILL.md +239 -0
- package/skills/domains/economics/development-economics-guide/SKILL.md +181 -0
- package/skills/domains/economics/fred-api/SKILL.md +189 -0
- package/skills/domains/education/curriculum-design-guide/SKILL.md +144 -0
- package/skills/domains/education/learning-science-guide/SKILL.md +150 -0
- package/skills/domains/finance/financial-data-analysis/SKILL.md +152 -0
- package/skills/domains/finance/quantitative-finance-guide/SKILL.md +151 -0
- package/skills/domains/geoscience/climate-science-guide/SKILL.md +158 -0
- package/skills/domains/geoscience/gis-remote-sensing-guide/SKILL.md +129 -0
- package/skills/domains/humanities/digital-humanities-guide/SKILL.md +181 -0
- package/skills/domains/humanities/philosophy-research-guide/SKILL.md +148 -0
- package/skills/domains/law/courtlistener-api/SKILL.md +213 -0
- package/skills/domains/law/legal-research-guide/SKILL.md +250 -0
- package/skills/domains/math/linear-algebra-applications/SKILL.md +227 -0
- package/skills/domains/math/numerical-methods-guide/SKILL.md +236 -0
- package/skills/domains/math/oeis-api/SKILL.md +158 -0
- package/skills/domains/pharma/clinical-pharmacology-guide/SKILL.md +165 -0
- package/skills/domains/pharma/drug-development-guide/SKILL.md +177 -0
- package/skills/domains/physics/computational-physics-guide/SKILL.md +300 -0
- package/skills/domains/physics/nasa-ads-api/SKILL.md +150 -0
- package/skills/domains/physics/quantum-computing-guide/SKILL.md +234 -0
- package/skills/domains/social-science/social-research-methods/SKILL.md +194 -0
- package/skills/domains/social-science/survey-research-guide/SKILL.md +182 -0
- package/skills/literature/discovery/citation-alert-guide/SKILL.md +154 -0
- package/skills/literature/discovery/conference-proceedings-guide/SKILL.md +142 -0
- package/skills/literature/discovery/literature-mapping-guide/SKILL.md +175 -0
- package/skills/literature/discovery/paper-tracking-guide/SKILL.md +211 -0
- package/skills/literature/discovery/rss-paper-feeds/SKILL.md +214 -0
- package/skills/literature/discovery/semantic-scholar-recs-guide/SKILL.md +164 -0
- package/skills/literature/fulltext/doaj-api/SKILL.md +120 -0
- package/skills/literature/fulltext/interlibrary-loan-guide/SKILL.md +163 -0
- package/skills/literature/fulltext/open-access-guide/SKILL.md +183 -0
- package/skills/literature/fulltext/pmc-oai-api/SKILL.md +184 -0
- package/skills/literature/fulltext/preprint-servers-guide/SKILL.md +128 -0
- package/skills/literature/fulltext/repository-harvesting-guide/SKILL.md +207 -0
- package/skills/literature/fulltext/unpaywall-api/SKILL.md +113 -0
- package/skills/literature/metadata/altmetrics-guide/SKILL.md +132 -0
- package/skills/literature/metadata/citation-network-guide/SKILL.md +236 -0
- package/skills/literature/metadata/crossref-api/SKILL.md +133 -0
- package/skills/literature/metadata/datacite-api/SKILL.md +126 -0
- package/skills/literature/metadata/doi-resolution-guide/SKILL.md +168 -0
- package/skills/literature/metadata/h-index-guide/SKILL.md +183 -0
- package/skills/literature/metadata/journal-metrics-guide/SKILL.md +188 -0
- package/skills/literature/metadata/opencitations-api/SKILL.md +128 -0
- package/skills/literature/metadata/orcid-api/SKILL.md +136 -0
- package/skills/literature/metadata/orcid-integration-guide/SKILL.md +178 -0
- package/skills/literature/search/arxiv-api/SKILL.md +95 -0
- package/skills/literature/search/biorxiv-api/SKILL.md +123 -0
- package/skills/literature/search/boolean-search-guide/SKILL.md +199 -0
- package/skills/literature/search/citation-chaining-guide/SKILL.md +148 -0
- package/skills/literature/search/database-comparison-guide/SKILL.md +100 -0
- package/skills/literature/search/europe-pmc-api/SKILL.md +120 -0
- package/skills/literature/search/google-scholar-guide/SKILL.md +182 -0
- package/skills/literature/search/mesh-terms-guide/SKILL.md +164 -0
- package/skills/literature/search/openalex-api/SKILL.md +134 -0
- package/skills/literature/search/pubmed-api/SKILL.md +130 -0
- package/skills/literature/search/scientify-literature-survey/SKILL.md +203 -0
- package/skills/literature/search/semantic-scholar-api/SKILL.md +134 -0
- package/skills/literature/search/systematic-search-strategy/SKILL.md +214 -0
- package/skills/research/automation/ai-scientist-guide/SKILL.md +228 -0
- package/skills/research/automation/data-collection-automation/SKILL.md +248 -0
- package/skills/research/automation/research-workflow-automation/SKILL.md +266 -0
- package/skills/research/deep-research/meta-synthesis-guide/SKILL.md +174 -0
- package/skills/research/deep-research/research-cog/SKILL.md +153 -0
- package/skills/research/deep-research/scoping-review-guide/SKILL.md +217 -0
- package/skills/research/deep-research/systematic-review-guide/SKILL.md +250 -0
- package/skills/research/funding/figshare-api/SKILL.md +163 -0
- package/skills/research/funding/grant-writing-guide/SKILL.md +233 -0
- package/skills/research/funding/nsf-grant-guide/SKILL.md +206 -0
- package/skills/research/funding/open-science-guide/SKILL.md +255 -0
- package/skills/research/funding/zenodo-api/SKILL.md +174 -0
- package/skills/research/methodology/action-research-guide/SKILL.md +201 -0
- package/skills/research/methodology/experimental-design-guide/SKILL.md +236 -0
- package/skills/research/methodology/grad-school-guide/SKILL.md +182 -0
- package/skills/research/methodology/grounded-theory-guide/SKILL.md +171 -0
- package/skills/research/methodology/mixed-methods-guide/SKILL.md +208 -0
- package/skills/research/methodology/qualitative-research-guide/SKILL.md +234 -0
- package/skills/research/methodology/scientify-idea-generation/SKILL.md +222 -0
- package/skills/research/paper-review/paper-reading-assistant/SKILL.md +266 -0
- package/skills/research/paper-review/peer-review-guide/SKILL.md +227 -0
- package/skills/research/paper-review/rebuttal-writing-guide/SKILL.md +185 -0
- package/skills/research/paper-review/scientify-write-review-paper/SKILL.md +209 -0
- package/skills/tools/code-exec/jupyter-notebook-guide/SKILL.md +178 -0
- package/skills/tools/code-exec/python-reproducibility-guide/SKILL.md +341 -0
- package/skills/tools/code-exec/r-reproducibility-guide/SKILL.md +236 -0
- package/skills/tools/code-exec/sandbox-execution-guide/SKILL.md +221 -0
- package/skills/tools/diagram/mermaid-diagram-guide/SKILL.md +269 -0
- package/skills/tools/diagram/plantuml-guide/SKILL.md +397 -0
- package/skills/tools/diagram/scientific-illustration-guide/SKILL.md +225 -0
- package/skills/tools/document/anystyle-api/SKILL.md +199 -0
- package/skills/tools/document/grobid-pdf-parsing/SKILL.md +294 -0
- package/skills/tools/document/markdown-academic-guide/SKILL.md +217 -0
- package/skills/tools/document/pdf-extraction-guide/SKILL.md +321 -0
- package/skills/tools/knowledge-graph/knowledge-graph-construction/SKILL.md +306 -0
- package/skills/tools/knowledge-graph/ontology-design-guide/SKILL.md +214 -0
- package/skills/tools/knowledge-graph/rag-methodology-guide/SKILL.md +325 -0
- package/skills/tools/ocr-translate/formula-recognition-guide/SKILL.md +367 -0
- package/skills/tools/ocr-translate/handwriting-recognition-guide/SKILL.md +211 -0
- package/skills/tools/ocr-translate/latex-ocr-guide/SKILL.md +204 -0
- package/skills/tools/ocr-translate/multilingual-research-guide/SKILL.md +234 -0
- package/skills/tools/scraping/academic-web-scraping/SKILL.md +326 -0
- package/skills/tools/scraping/api-data-collection-guide/SKILL.md +301 -0
- package/skills/tools/scraping/web-scraping-ethics-guide/SKILL.md +250 -0
- package/skills/writing/citation/bibtex-management-guide/SKILL.md +246 -0
- package/skills/writing/citation/citation-style-guide/SKILL.md +248 -0
- package/skills/writing/citation/reference-manager-comparison/SKILL.md +208 -0
- package/skills/writing/citation/zotero-api/SKILL.md +188 -0
- package/skills/writing/composition/abstract-writing-guide/SKILL.md +188 -0
- package/skills/writing/composition/discussion-writing-guide/SKILL.md +194 -0
- package/skills/writing/composition/introduction-writing-guide/SKILL.md +194 -0
- package/skills/writing/composition/literature-review-writing/SKILL.md +196 -0
- package/skills/writing/composition/methods-section-guide/SKILL.md +185 -0
- package/skills/writing/composition/response-to-reviewers/SKILL.md +215 -0
- package/skills/writing/composition/scientific-writing-guide/SKILL.md +152 -0
- package/skills/writing/latex/bibliography-management-guide/SKILL.md +206 -0
- package/skills/writing/latex/latex-drawing-guide/SKILL.md +234 -0
- package/skills/writing/latex/latex-ecosystem-guide/SKILL.md +240 -0
- package/skills/writing/latex/math-typesetting-guide/SKILL.md +231 -0
- package/skills/writing/latex/overleaf-collaboration-guide/SKILL.md +211 -0
- package/skills/writing/latex/tikz-diagrams-guide/SKILL.md +211 -0
- package/skills/writing/polish/academic-translation-guide/SKILL.md +175 -0
- package/skills/writing/polish/academic-writing-refiner/SKILL.md +143 -0
- package/skills/writing/polish/ai-writing-humanizer/SKILL.md +178 -0
- package/skills/writing/polish/grammar-checker-guide/SKILL.md +184 -0
- package/skills/writing/polish/plagiarism-detection-guide/SKILL.md +167 -0
- package/skills/writing/templates/beamer-presentation-guide/SKILL.md +263 -0
- package/skills/writing/templates/conference-paper-template/SKILL.md +219 -0
- package/skills/writing/templates/thesis-template-guide/SKILL.md +200 -0
- package/skills/writing/templates/thesis-writing-guide/SKILL.md +220 -0
- package/src/tools/arxiv.ts +131 -0
- package/src/tools/crossref.ts +112 -0
- package/src/tools/openalex.ts +174 -0
- package/src/tools/pubmed.ts +166 -0
- package/src/tools/semantic-scholar.ts +108 -0
- package/src/tools/unpaywall.ts +58 -0
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: literature-review-writing
|
|
3
|
+
description: "Structure and write comprehensive literature reviews for any field"
|
|
4
|
+
metadata:
|
|
5
|
+
openclaw:
|
|
6
|
+
emoji: "scroll"
|
|
7
|
+
category: "writing"
|
|
8
|
+
subcategory: "composition"
|
|
9
|
+
keywords: ["literature review", "systematic review", "narrative review", "synthesis", "academic writing", "review paper"]
|
|
10
|
+
source: "wentor-research-plugins"
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Literature Review Writing
|
|
14
|
+
|
|
15
|
+
A skill for structuring, synthesizing, and writing literature reviews. Covers narrative reviews, systematic reviews, scoping reviews, and literature review sections within empirical papers. Provides frameworks for organizing sources, identifying themes, and writing with synthesis rather than summary.
|
|
16
|
+
|
|
17
|
+
## Types of Literature Reviews
|
|
18
|
+
|
|
19
|
+
### Choosing the Right Review Type
|
|
20
|
+
|
|
21
|
+
| Type | Purpose | Search | Analysis | Length |
|
|
22
|
+
|------|---------|--------|----------|--------|
|
|
23
|
+
| Narrative | Broad overview of a topic | Selective | Qualitative synthesis | 5-30 pages |
|
|
24
|
+
| Systematic | Answer a specific question exhaustively | Exhaustive, documented | May include meta-analysis | 10-40 pages |
|
|
25
|
+
| Scoping | Map the extent of research on a topic | Broad, systematic | Charting and categorizing | 10-20 pages |
|
|
26
|
+
| Integrative | Synthesize diverse methodologies | Targeted | Conceptual synthesis | 10-25 pages |
|
|
27
|
+
| Umbrella | Review of systematic reviews | Focused on SRs | Synthesis of syntheses | 10-20 pages |
|
|
28
|
+
|
|
29
|
+
## Organizing Your Sources
|
|
30
|
+
|
|
31
|
+
### Building a Literature Matrix
|
|
32
|
+
|
|
33
|
+
```python
|
|
34
|
+
def create_literature_matrix(sources: list[dict]) -> dict:
|
|
35
|
+
"""
|
|
36
|
+
Create a structured matrix for organizing reviewed literature.
|
|
37
|
+
|
|
38
|
+
Args:
|
|
39
|
+
sources: List of dicts with keys: author, year, title, method,
|
|
40
|
+
sample, key_findings, themes, limitations
|
|
41
|
+
"""
|
|
42
|
+
matrix = {
|
|
43
|
+
"headers": [
|
|
44
|
+
"Author (Year)", "Research Question", "Method",
|
|
45
|
+
"Sample/Data", "Key Findings", "Themes", "Limitations"
|
|
46
|
+
],
|
|
47
|
+
"rows": [],
|
|
48
|
+
"theme_index": {}
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
for src in sources:
|
|
52
|
+
row = {
|
|
53
|
+
"citation": f"{src['author']} ({src['year']})",
|
|
54
|
+
"question": src.get("research_question", ""),
|
|
55
|
+
"method": src.get("method", ""),
|
|
56
|
+
"sample": src.get("sample", ""),
|
|
57
|
+
"findings": src.get("key_findings", ""),
|
|
58
|
+
"themes": src.get("themes", []),
|
|
59
|
+
"limitations": src.get("limitations", "")
|
|
60
|
+
}
|
|
61
|
+
matrix["rows"].append(row)
|
|
62
|
+
|
|
63
|
+
for theme in src.get("themes", []):
|
|
64
|
+
matrix["theme_index"].setdefault(theme, []).append(
|
|
65
|
+
row["citation"]
|
|
66
|
+
)
|
|
67
|
+
|
|
68
|
+
return matrix
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Thematic vs. Chronological Organization
|
|
72
|
+
|
|
73
|
+
```
|
|
74
|
+
Chronological (rarely ideal for reviews):
|
|
75
|
+
"In 2010, Smith found X. Then in 2012, Jones found Y.
|
|
76
|
+
In 2015, Lee found Z."
|
|
77
|
+
Problem: Reads like an annotated bibliography, not a synthesis.
|
|
78
|
+
|
|
79
|
+
Thematic (recommended):
|
|
80
|
+
"Three factors have been identified as predictors of X.
|
|
81
|
+
First, [factor A] has been consistently supported (Smith, 2010;
|
|
82
|
+
Jones, 2012; Lee, 2015). Second, [factor B] shows mixed results..."
|
|
83
|
+
Advantage: Synthesizes findings around conceptual themes.
|
|
84
|
+
|
|
85
|
+
Methodological (useful for systematic reviews):
|
|
86
|
+
"Studies using qualitative methods (n=12) found [pattern],
|
|
87
|
+
while quantitative studies (n=25) reported [different pattern].
|
|
88
|
+
This methodological divide suggests..."
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## Writing with Synthesis
|
|
92
|
+
|
|
93
|
+
### Summary vs. Synthesis
|
|
94
|
+
|
|
95
|
+
```
|
|
96
|
+
Summary (weak -- describes one paper at a time):
|
|
97
|
+
"Smith (2020) studied 200 undergraduates and found that sleep
|
|
98
|
+
quality predicted academic performance. Jones (2021) surveyed
|
|
99
|
+
150 graduate students and found a similar relationship."
|
|
100
|
+
|
|
101
|
+
Synthesis (strong -- integrates multiple sources around a point):
|
|
102
|
+
"Sleep quality has been consistently linked to academic performance
|
|
103
|
+
across both undergraduate (Smith, 2020; Lee, 2019) and graduate
|
|
104
|
+
(Jones, 2021) populations, with effect sizes ranging from r=0.25
|
|
105
|
+
to r=0.42. However, this relationship may be confounded by
|
|
106
|
+
socioeconomic factors (Park, 2022), which only two studies
|
|
107
|
+
controlled for."
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Synthesis Sentence Starters
|
|
111
|
+
|
|
112
|
+
```
|
|
113
|
+
Agreement:
|
|
114
|
+
"There is broad consensus that..."
|
|
115
|
+
"Multiple studies converge on the finding that..."
|
|
116
|
+
"This finding has been replicated across [contexts]..."
|
|
117
|
+
|
|
118
|
+
Disagreement:
|
|
119
|
+
"However, findings diverge regarding..."
|
|
120
|
+
"In contrast to the majority view, [author] argues..."
|
|
121
|
+
"The evidence is mixed, with some studies reporting [X] and others [Y]..."
|
|
122
|
+
|
|
123
|
+
Gap identification:
|
|
124
|
+
"Notably absent from this literature is..."
|
|
125
|
+
"While [aspect] has been well studied, [gap] remains unexplored..."
|
|
126
|
+
"No studies to date have examined [specific gap]..."
|
|
127
|
+
|
|
128
|
+
Transition:
|
|
129
|
+
"Taken together, these findings suggest..."
|
|
130
|
+
"Building on this body of work, recent studies have begun to..."
|
|
131
|
+
"This line of research has evolved from [earlier focus] to [current focus]..."
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## Structuring the Review
|
|
135
|
+
|
|
136
|
+
### Standard Sections
|
|
137
|
+
|
|
138
|
+
```
|
|
139
|
+
1. Introduction (1-2 pages)
|
|
140
|
+
- Define the topic and scope
|
|
141
|
+
- Explain why this review is needed (gap, timeliness, controversy)
|
|
142
|
+
- State the review's objectives or research questions
|
|
143
|
+
|
|
144
|
+
2. Methods (for systematic/scoping reviews)
|
|
145
|
+
- Search strategy, databases, date range
|
|
146
|
+
- Inclusion/exclusion criteria
|
|
147
|
+
- Screening process (PRISMA flow diagram)
|
|
148
|
+
|
|
149
|
+
3. Body: Thematic Sections (bulk of the review)
|
|
150
|
+
- Each section covers a theme, construct, or sub-question
|
|
151
|
+
- Synthesize rather than summarize
|
|
152
|
+
- Use tables to compare studies when appropriate
|
|
153
|
+
|
|
154
|
+
4. Discussion / Synthesis
|
|
155
|
+
- What is the overall state of knowledge?
|
|
156
|
+
- Where do studies agree and disagree?
|
|
157
|
+
- What are the gaps?
|
|
158
|
+
|
|
159
|
+
5. Conclusion / Future Directions
|
|
160
|
+
- Summarize the key takeaways
|
|
161
|
+
- Propose a research agenda addressing identified gaps
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
## Common Pitfalls
|
|
165
|
+
|
|
166
|
+
### What Reviewers Look For
|
|
167
|
+
|
|
168
|
+
```
|
|
169
|
+
Problem: "Laundry list" structure
|
|
170
|
+
- Each paragraph describes one study in isolation
|
|
171
|
+
Fix: Group studies by theme and synthesize across them
|
|
172
|
+
|
|
173
|
+
Problem: Missing recent literature
|
|
174
|
+
- Review stops at 2020 in a fast-moving field
|
|
175
|
+
Fix: Search within the last 12 months before submission
|
|
176
|
+
|
|
177
|
+
Problem: Uncritical acceptance
|
|
178
|
+
- All studies treated as equally valid
|
|
179
|
+
Fix: Evaluate methodological quality and note study limitations
|
|
180
|
+
|
|
181
|
+
Problem: No conceptual framework
|
|
182
|
+
- Sources listed without a guiding structure
|
|
183
|
+
Fix: Start with a framework (theoretical, conceptual, or thematic map)
|
|
184
|
+
|
|
185
|
+
Problem: Omitting contradictory evidence
|
|
186
|
+
- Only citing studies that support the authors' position
|
|
187
|
+
Fix: Actively seek and discuss disconfirming evidence
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
## Tools for Literature Review Management
|
|
191
|
+
|
|
192
|
+
- **Zotero + ZotFile**: Organize PDFs, tag by theme, generate bibliographies
|
|
193
|
+
- **Covidence**: Systematic review screening and data extraction
|
|
194
|
+
- **Rayyan**: Free AI-assisted abstract screening for systematic reviews
|
|
195
|
+
- **Notion/Obsidian**: Build a literature matrix with linked notes
|
|
196
|
+
- **VOSviewer**: Bibliometric visualization of citation networks and keyword clusters
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: methods-section-guide
|
|
3
|
+
description: "Guide to writing clear and reproducible methodology sections"
|
|
4
|
+
metadata:
|
|
5
|
+
openclaw:
|
|
6
|
+
emoji: "gear"
|
|
7
|
+
category: "writing"
|
|
8
|
+
subcategory: "composition"
|
|
9
|
+
keywords: ["methods writing", "methodology section", "reproducible methods"]
|
|
10
|
+
source: "wentor-research-plugins"
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Methods Section Writing Guide
|
|
14
|
+
|
|
15
|
+
Write methodology sections that are clear, complete, and reproducible, following discipline-specific conventions and best practices.
|
|
16
|
+
|
|
17
|
+
## Purpose of the Methods Section
|
|
18
|
+
|
|
19
|
+
The methods section answers: "How did you do this study, and can someone else replicate it?" A well-written methods section:
|
|
20
|
+
|
|
21
|
+
- Provides enough detail for replication by an independent researcher
|
|
22
|
+
- Justifies why each method was chosen
|
|
23
|
+
- Describes the study design, participants, materials, and procedures
|
|
24
|
+
- Specifies statistical or analytical approaches
|
|
25
|
+
- Addresses ethical considerations
|
|
26
|
+
|
|
27
|
+
## Standard Structure
|
|
28
|
+
|
|
29
|
+
The methods section typically follows this order (adapt to your discipline):
|
|
30
|
+
|
|
31
|
+
| Subsection | Contents |
|
|
32
|
+
|-----------|----------|
|
|
33
|
+
| **Study Design** | Overall approach (experimental, observational, computational, qualitative) |
|
|
34
|
+
| **Participants / Samples** | Population, sampling strategy, inclusion/exclusion criteria, sample size justification |
|
|
35
|
+
| **Materials / Instruments** | Equipment, software, reagents, questionnaires, datasets |
|
|
36
|
+
| **Procedure** | Step-by-step protocol, chronological order of data collection |
|
|
37
|
+
| **Data Analysis** | Statistical tests, software, significance thresholds, model specifications |
|
|
38
|
+
| **Ethical Considerations** | IRB approval, informed consent, data privacy |
|
|
39
|
+
|
|
40
|
+
## Writing by Discipline
|
|
41
|
+
|
|
42
|
+
### Experimental Sciences (Biology, Chemistry, Physics)
|
|
43
|
+
|
|
44
|
+
```markdown
|
|
45
|
+
## Materials and Methods
|
|
46
|
+
|
|
47
|
+
### Cell Culture and Treatment
|
|
48
|
+
HeLa cells (ATCC CCL-2) were maintained in DMEM (Gibco, #11965092)
|
|
49
|
+
supplemented with 10% FBS (Gibco, #26140079) and 1% penicillin-
|
|
50
|
+
streptomycin (Gibco, #15140122) at 37C in 5% CO2. Cells were
|
|
51
|
+
seeded at 5 x 10^4 cells/well in 24-well plates and treated with
|
|
52
|
+
compound X (0.1, 1, 10 uM) for 24 hours.
|
|
53
|
+
|
|
54
|
+
### Western Blot Analysis
|
|
55
|
+
Total protein was extracted using RIPA buffer (Thermo, #89900)
|
|
56
|
+
with protease inhibitor cocktail (Roche, #04693116001). Proteins
|
|
57
|
+
(30 ug/lane) were separated on 10% SDS-PAGE gels and transferred
|
|
58
|
+
to PVDF membranes. Primary antibodies: anti-TargetProtein
|
|
59
|
+
(Cell Signaling, #1234, 1:1000), anti-beta-actin (Sigma, #A5441,
|
|
60
|
+
1:5000). Secondary antibodies: HRP-conjugated (1:10000).
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Key conventions:
|
|
64
|
+
- Include catalog numbers for all reagents
|
|
65
|
+
- Specify concentrations, temperatures, durations, and instrument models
|
|
66
|
+
- Reference established protocols by citation rather than rewriting them in full
|
|
67
|
+
- Use past tense throughout
|
|
68
|
+
|
|
69
|
+
### Computational / Machine Learning Studies
|
|
70
|
+
|
|
71
|
+
```markdown
|
|
72
|
+
## Methods
|
|
73
|
+
|
|
74
|
+
### Dataset
|
|
75
|
+
We evaluated our method on three benchmark datasets:
|
|
76
|
+
- **ImageNet-1K** (Russakovsky et al., 2015): 1.28M training images,
|
|
77
|
+
50K validation images across 1,000 classes
|
|
78
|
+
- **CIFAR-100** (Krizhevsky, 2009): 50K training, 10K test, 100 classes
|
|
79
|
+
- **Oxford Flowers-102** (Nilsback & Zisserman, 2008): 8,189 images, 102 classes
|
|
80
|
+
|
|
81
|
+
### Model Architecture
|
|
82
|
+
Our model extends the Vision Transformer (ViT-B/16) with the
|
|
83
|
+
following modifications:
|
|
84
|
+
1. Replaced standard self-attention with linear attention (Katharopoulos et al., 2020)
|
|
85
|
+
2. Added a learnable class-conditional normalization layer after each block
|
|
86
|
+
3. Used patch size 16x16 with input resolution 224x224
|
|
87
|
+
|
|
88
|
+
### Training Details
|
|
89
|
+
| Hyperparameter | Value |
|
|
90
|
+
|---------------|-------|
|
|
91
|
+
| Optimizer | AdamW (beta1=0.9, beta2=0.999) |
|
|
92
|
+
| Learning rate | 1e-3 with cosine decay |
|
|
93
|
+
| Weight decay | 0.05 |
|
|
94
|
+
| Batch size | 256 (across 4 A100 GPUs) |
|
|
95
|
+
| Training epochs | 300 |
|
|
96
|
+
| Warmup epochs | 10 |
|
|
97
|
+
| Data augmentation | RandAugment (N=2, M=9), Mixup (alpha=0.8) |
|
|
98
|
+
| Label smoothing | 0.1 |
|
|
99
|
+
|
|
100
|
+
All experiments were implemented in PyTorch 2.1 and run on 4x NVIDIA A100
|
|
101
|
+
80GB GPUs. Training took approximately 18 hours per run. Code is available
|
|
102
|
+
at [repository URL].
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### Social Science / Survey Research
|
|
106
|
+
|
|
107
|
+
```markdown
|
|
108
|
+
## Methods
|
|
109
|
+
|
|
110
|
+
### Participants
|
|
111
|
+
A total of 412 participants (245 female, 162 male, 5 non-binary;
|
|
112
|
+
M_age = 34.2, SD = 11.8) were recruited via Prolific. Inclusion
|
|
113
|
+
criteria: (a) aged 18-65, (b) fluent in English, (c) resided in
|
|
114
|
+
the US. Exclusion criteria: (a) failed two or more attention checks,
|
|
115
|
+
(b) completed the survey in under 3 minutes. After exclusions,
|
|
116
|
+
387 participants remained (attrition: 6.1%).
|
|
117
|
+
|
|
118
|
+
Sample size was determined a priori using G*Power 3.1 (Faul et al., 2007).
|
|
119
|
+
For a medium effect size (f^2 = 0.15), alpha = .05, and power = .80
|
|
120
|
+
in a multiple regression with 5 predictors, the required sample was 92.
|
|
121
|
+
We oversampled to ensure adequate power for subgroup analyses.
|
|
122
|
+
|
|
123
|
+
### Measures
|
|
124
|
+
|
|
125
|
+
**Perceived Stress Scale (PSS-10)** (Cohen et al., 1983): 10 items,
|
|
126
|
+
5-point Likert scale (0 = never, 4 = very often). Cronbach's alpha
|
|
127
|
+
in the current sample: .87.
|
|
128
|
+
|
|
129
|
+
**Big Five Inventory (BFI-10)** (Rammstedt & John, 2007): 10 items,
|
|
130
|
+
5-point Likert scale. Subscale alphas ranged from .68 to .81.
|
|
131
|
+
|
|
132
|
+
### Procedure
|
|
133
|
+
After providing informed consent, participants completed measures in
|
|
134
|
+
the following fixed order: demographics, PSS-10, BFI-10, experimental
|
|
135
|
+
task, manipulation check, debriefing. Median completion time: 14 minutes.
|
|
136
|
+
Participants were compensated GBP 2.50.
|
|
137
|
+
|
|
138
|
+
### Ethical Approval
|
|
139
|
+
This study was approved by the [University] IRB (Protocol #2024-0123).
|
|
140
|
+
All participants provided informed consent.
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
## Reproducibility Checklist
|
|
144
|
+
|
|
145
|
+
Use this checklist to ensure your methods section is complete:
|
|
146
|
+
|
|
147
|
+
### For All Studies
|
|
148
|
+
|
|
149
|
+
- [ ] Study design and rationale clearly stated
|
|
150
|
+
- [ ] Sample/dataset described with inclusion/exclusion criteria
|
|
151
|
+
- [ ] Sample size justified (power analysis, saturation, or convention)
|
|
152
|
+
- [ ] All measures and instruments described with psychometric properties or specifications
|
|
153
|
+
- [ ] Procedure described in chronological order with enough detail for replication
|
|
154
|
+
- [ ] Statistical/analytical methods specified, including software and version
|
|
155
|
+
- [ ] Significance level (alpha) stated
|
|
156
|
+
- [ ] Missing data handling described
|
|
157
|
+
- [ ] Ethical approval and consent documented
|
|
158
|
+
|
|
159
|
+
### For Computational Studies
|
|
160
|
+
|
|
161
|
+
- [ ] Hardware specifications (GPU model, memory, training time)
|
|
162
|
+
- [ ] Software framework and version (PyTorch 2.1, TensorFlow 2.15, etc.)
|
|
163
|
+
- [ ] All hyperparameters listed in a table
|
|
164
|
+
- [ ] Random seed policy described
|
|
165
|
+
- [ ] Code and data availability statement
|
|
166
|
+
- [ ] Evaluation metrics defined precisely
|
|
167
|
+
- [ ] Baseline methods described or cited
|
|
168
|
+
|
|
169
|
+
## Common Pitfalls
|
|
170
|
+
|
|
171
|
+
| Issue | Example | Fix |
|
|
172
|
+
|-------|---------|-----|
|
|
173
|
+
| Vague descriptions | "Data was analyzed statistically" | Specify exact tests: "We used a two-tailed independent samples t-test" |
|
|
174
|
+
| Missing software versions | "Analysis done in R" | "Analysis conducted in R 4.3.1 using lme4 v1.1-35" |
|
|
175
|
+
| No sample size justification | Just reporting N | Include power analysis or justify based on conventions |
|
|
176
|
+
| Ambiguous order | Reader cannot tell what happened when | Use numbered steps or chronological narrative |
|
|
177
|
+
| Results in methods | Including p-values or outcomes | Save all results for the Results section |
|
|
178
|
+
| Over-referencing | Citing a protocol without summarizing key details | Provide enough detail to understand without reading the reference |
|
|
179
|
+
|
|
180
|
+
## Language and Tense
|
|
181
|
+
|
|
182
|
+
- Use **past tense** for what you did: "Participants completed a questionnaire..."
|
|
183
|
+
- Use **present tense** for established methods: "ANOVA tests for differences between group means..."
|
|
184
|
+
- Use **passive voice** when the agent is unimportant: "Samples were centrifuged at 12,000 rpm..."
|
|
185
|
+
- Use **active voice** when clarity is improved: "We excluded participants who..."
|
|
@@ -0,0 +1,215 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: response-to-reviewers
|
|
3
|
+
description: "Write effective point-by-point responses to peer reviewer comments for revisions"
|
|
4
|
+
metadata:
|
|
5
|
+
openclaw:
|
|
6
|
+
emoji: "envelope"
|
|
7
|
+
category: "writing"
|
|
8
|
+
subcategory: "composition"
|
|
9
|
+
keywords: ["response to reviewers", "revision letter", "point-by-point response", "cover letter writing", "manuscript revision"]
|
|
10
|
+
source: "wentor"
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Response to Reviewers Guide
|
|
14
|
+
|
|
15
|
+
A skill for crafting professional, thorough responses to peer reviewer comments during manuscript revision. Covers structure, tone, strategies for handling difficult comments, and templates for common revision scenarios.
|
|
16
|
+
|
|
17
|
+
## Response Document Structure
|
|
18
|
+
|
|
19
|
+
### Standard Format
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
Dear Editor,
|
|
23
|
+
|
|
24
|
+
Thank you for the opportunity to revise our manuscript entitled "[Title]"
|
|
25
|
+
(Manuscript ID: [ID]). We appreciate the constructive feedback from the
|
|
26
|
+
reviewers and have carefully addressed all comments. Below, we provide
|
|
27
|
+
a point-by-point response to each comment.
|
|
28
|
+
|
|
29
|
+
Major changes include:
|
|
30
|
+
1. [Summary of major change 1]
|
|
31
|
+
2. [Summary of major change 2]
|
|
32
|
+
3. [Summary of major change 3]
|
|
33
|
+
|
|
34
|
+
All changes in the revised manuscript are highlighted in blue.
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
REVIEWER 1
|
|
39
|
+
|
|
40
|
+
Comment 1.1: [Quote or paraphrase the reviewer's comment]
|
|
41
|
+
|
|
42
|
+
Response: [Your response]
|
|
43
|
+
[Reference to specific changes: "We have revised Section 3.2,
|
|
44
|
+
paragraph 2 (lines 145-158) to address this concern."]
|
|
45
|
+
|
|
46
|
+
Comment 1.2: ...
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
REVIEWER 2
|
|
51
|
+
|
|
52
|
+
Comment 2.1: ...
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
We believe these revisions have substantially strengthened the manuscript
|
|
57
|
+
and hope you find it suitable for publication in [Journal Name].
|
|
58
|
+
|
|
59
|
+
Sincerely,
|
|
60
|
+
[Authors]
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Response Strategy Framework
|
|
64
|
+
|
|
65
|
+
```python
|
|
66
|
+
def classify_reviewer_comment(comment: str) -> dict:
|
|
67
|
+
"""
|
|
68
|
+
Classify a reviewer comment to determine the appropriate response strategy.
|
|
69
|
+
|
|
70
|
+
Returns strategy recommendation for each comment type.
|
|
71
|
+
"""
|
|
72
|
+
strategies = {
|
|
73
|
+
'factual_error': {
|
|
74
|
+
'description': 'Reviewer points out a genuine error',
|
|
75
|
+
'strategy': 'Acknowledge, correct, and thank the reviewer',
|
|
76
|
+
'template': 'We thank the reviewer for identifying this error. '
|
|
77
|
+
'We have corrected [specific change] in [location].',
|
|
78
|
+
'tone': 'grateful'
|
|
79
|
+
},
|
|
80
|
+
'clarification_needed': {
|
|
81
|
+
'description': 'Reviewer misunderstood due to unclear writing',
|
|
82
|
+
'strategy': 'Rewrite the unclear section; do not blame the reviewer',
|
|
83
|
+
'template': 'We appreciate this comment and recognize that our original '
|
|
84
|
+
'wording was unclear. We have revised [section] to clarify that...',
|
|
85
|
+
'tone': 'constructive'
|
|
86
|
+
},
|
|
87
|
+
'additional_analysis': {
|
|
88
|
+
'description': 'Reviewer requests new analyses or experiments',
|
|
89
|
+
'strategy': 'Perform if feasible; explain limitations if not',
|
|
90
|
+
'template': 'We have performed the requested analysis. [Results]. '
|
|
91
|
+
'These results are now presented in [Figure/Table X].',
|
|
92
|
+
'tone': 'responsive'
|
|
93
|
+
},
|
|
94
|
+
'methodological_concern': {
|
|
95
|
+
'description': 'Reviewer questions methodology',
|
|
96
|
+
'strategy': 'Provide justification with references; add robustness checks',
|
|
97
|
+
'template': 'This is an excellent point. Our methodological choice was based on '
|
|
98
|
+
'[rationale + citation]. As a robustness check, we have also...',
|
|
99
|
+
'tone': 'scholarly'
|
|
100
|
+
},
|
|
101
|
+
'scope_expansion': {
|
|
102
|
+
'description': 'Reviewer asks to expand beyond paper scope',
|
|
103
|
+
'strategy': 'Acknowledge value; explain scope boundaries respectfully',
|
|
104
|
+
'template': 'We agree this is an interesting direction. However, this analysis '
|
|
105
|
+
'is beyond the scope of the current study because [reason]. '
|
|
106
|
+
'We have added this as a direction for future research in the Discussion.',
|
|
107
|
+
'tone': 'respectful_boundary'
|
|
108
|
+
},
|
|
109
|
+
'disagreement': {
|
|
110
|
+
'description': 'You disagree with the reviewer substantively',
|
|
111
|
+
'strategy': 'Present evidence-based counter-argument respectfully',
|
|
112
|
+
'template': 'We appreciate this perspective. After careful consideration, '
|
|
113
|
+
'we respectfully maintain our original interpretation because [evidence]. '
|
|
114
|
+
'However, we have added a discussion of this alternative view in [section].',
|
|
115
|
+
'tone': 'diplomatic'
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
# Simple keyword-based classification
|
|
120
|
+
comment_lower = comment.lower()
|
|
121
|
+
if any(w in comment_lower for w in ['error', 'mistake', 'incorrect', 'wrong']):
|
|
122
|
+
return strategies['factual_error']
|
|
123
|
+
elif any(w in comment_lower for w in ['unclear', 'confusing', 'what do you mean']):
|
|
124
|
+
return strategies['clarification_needed']
|
|
125
|
+
elif any(w in comment_lower for w in ['additional', 'also analyze', 'please include']):
|
|
126
|
+
return strategies['additional_analysis']
|
|
127
|
+
elif any(w in comment_lower for w in ['method', 'approach', 'why did you']):
|
|
128
|
+
return strategies['methodological_concern']
|
|
129
|
+
elif any(w in comment_lower for w in ['beyond', 'also consider', 'broader']):
|
|
130
|
+
return strategies['scope_expansion']
|
|
131
|
+
else:
|
|
132
|
+
return strategies['clarification_needed'] # default safe strategy
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
## Handling Difficult Situations
|
|
136
|
+
|
|
137
|
+
### When You Disagree with a Reviewer
|
|
138
|
+
|
|
139
|
+
Never dismiss a reviewer's concern outright. The formula:
|
|
140
|
+
|
|
141
|
+
```
|
|
142
|
+
1. Acknowledge the reviewer's point
|
|
143
|
+
"We appreciate this thoughtful observation."
|
|
144
|
+
|
|
145
|
+
2. Present your reasoning with evidence
|
|
146
|
+
"Our approach is supported by [Author, Year] who demonstrated..."
|
|
147
|
+
|
|
148
|
+
3. Show you have considered the alternative
|
|
149
|
+
"We have added a paragraph discussing this alternative interpretation
|
|
150
|
+
(Section 4.3, lines 312-325)."
|
|
151
|
+
|
|
152
|
+
4. Offer a compromise when possible
|
|
153
|
+
"As a compromise, we have added a sensitivity analysis using the
|
|
154
|
+
reviewer's suggested approach, which yields consistent results
|
|
155
|
+
(Supplementary Table S3)."
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### When a Requested Analysis is Infeasible
|
|
159
|
+
|
|
160
|
+
```
|
|
161
|
+
Structure:
|
|
162
|
+
1. Explain why it cannot be done
|
|
163
|
+
"Unfortunately, [specific reason] prevents us from performing this
|
|
164
|
+
analysis. [Data was not collected / sample size is insufficient /
|
|
165
|
+
IRB protocol does not cover this]."
|
|
166
|
+
|
|
167
|
+
2. Offer the closest feasible alternative
|
|
168
|
+
"As an alternative, we have conducted [alternative analysis],
|
|
169
|
+
which addresses the same underlying concern."
|
|
170
|
+
|
|
171
|
+
3. Acknowledge the limitation
|
|
172
|
+
"We have added this as a limitation in Section 5.2."
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
## Cover Letter for Revision
|
|
176
|
+
|
|
177
|
+
```python
|
|
178
|
+
def generate_cover_letter(journal: str, manuscript_id: str, title: str,
|
|
179
|
+
major_changes: list[str],
|
|
180
|
+
editor_name: str = "Editor") -> str:
|
|
181
|
+
"""Generate a revision cover letter template."""
|
|
182
|
+
changes_list = '\n'.join(f' {i+1}. {c}' for i, c in enumerate(major_changes))
|
|
183
|
+
|
|
184
|
+
return f"""Dear {editor_name},
|
|
185
|
+
|
|
186
|
+
We are pleased to submit our revised manuscript entitled "{title}"
|
|
187
|
+
(Manuscript ID: {manuscript_id}) for consideration in {journal}.
|
|
188
|
+
|
|
189
|
+
We thank you and the reviewers for the constructive and insightful
|
|
190
|
+
comments, which have significantly improved the quality of our work.
|
|
191
|
+
We have carefully addressed all reviewer comments in the attached
|
|
192
|
+
point-by-point response document.
|
|
193
|
+
|
|
194
|
+
The major revisions include:
|
|
195
|
+
{changes_list}
|
|
196
|
+
|
|
197
|
+
All changes are highlighted in blue in the revised manuscript.
|
|
198
|
+
A clean version is also provided.
|
|
199
|
+
|
|
200
|
+
We believe the revised manuscript now fully addresses the reviewers'
|
|
201
|
+
concerns and is suitable for publication in {journal}.
|
|
202
|
+
|
|
203
|
+
Sincerely,
|
|
204
|
+
[Corresponding Author Name]
|
|
205
|
+
[Affiliation]
|
|
206
|
+
[Email]"""
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
## Revision Tracking Best Practices
|
|
210
|
+
|
|
211
|
+
- Use track changes or highlight all modified text in the revised manuscript
|
|
212
|
+
- Provide both a marked-up version and a clean version
|
|
213
|
+
- Reference specific line numbers, figure numbers, or section numbers
|
|
214
|
+
- If the revision substantially changes a figure or table, include the old and new versions side by side in the response document
|
|
215
|
+
- Submit the revision within the editor's requested timeline (typically 30-90 days)
|