mirror of
https://github.com/K-Dense-AI/claude-scientific-skills.git
synced 2026-01-26 16:58:56 +08:00
Enhance citation management and literature review guidelines
- Updated SKILL.md in citation management to include best practices for identifying seminal and high-impact papers, emphasizing citation count thresholds, venue quality tiers, and author reputation indicators. - Expanded literature review SKILL.md to prioritize high-impact papers, detailing citation metrics, journal tiers, and author reputation assessment. - Added comprehensive evaluation strategies for paper impact and quality in literature_search_strategies.md, including citation count significance and journal impact factor guidance. - Improved research lookup scripts to prioritize results based on citation count, venue prestige, and author reputation, enhancing the quality of research outputs.
This commit is contained in:
Vinayak Agarwal
@@ -33,38 +33,95 @@ This skill should be used when:
|
||||
|
||||
## Visual Enhancement with Scientific Schematics
|
||||
|
||||
**⚠️ MANDATORY: Every scientific paper MUST include at least 1-2 AI-generated figures using the scientific-schematics skill.**
|
||||
**⚠️ MANDATORY: Every scientific paper MUST include a graphical abstract plus 1-2 additional AI-generated figures using the scientific-schematics skill.**
|
||||
|
||||
This is not optional. Scientific papers without visual elements are incomplete. Before finalizing any document:
|
||||
1. Generate at minimum ONE schematic or diagram using scientific-schematics
|
||||
2. Prefer 2-3 figures for comprehensive papers (methods flowchart, results visualization, conceptual diagram)
|
||||
1. **ALWAYS generate a graphical abstract** as the first visual element
|
||||
2. Generate at minimum ONE additional schematic or diagram using scientific-schematics
|
||||
3. Prefer 3-4 total figures for comprehensive papers (graphical abstract + methods flowchart + results visualization + conceptual diagram)
|
||||
|
||||
**How to generate figures:**
|
||||
- Use the **scientific-schematics** skill to generate AI-powered publication-quality diagrams
|
||||
- Simply describe your desired diagram in natural language
|
||||
- Nano Banana Pro will automatically generate, review, and refine the schematic
|
||||
### Graphical Abstract (REQUIRED)
|
||||
|
||||
**How to generate schematics:**
|
||||
**Every scientific writeup MUST include a graphical abstract.** This is a visual summary of your paper that:
|
||||
- Appears before or immediately after the text abstract
|
||||
- Captures the entire paper's key message in one image
|
||||
- Is suitable for journal table of contents display
|
||||
- Uses landscape orientation (typically 1200x600px)
|
||||
|
||||
**Generate the graphical abstract FIRST:**
|
||||
```bash
|
||||
python scripts/generate_schematic.py "Graphical abstract for [paper title]: [brief description showing workflow from input → methods → key findings → conclusions]" -o figures/graphical_abstract.png
|
||||
```
|
||||
|
||||
**Graphical Abstract Requirements:**
|
||||
- **Content**: Visual summary showing workflow, key methods, main findings, and conclusions
|
||||
- **Style**: Clean, professional, suitable for journal TOC
|
||||
- **Elements**: Include 3-5 key steps/concepts with connecting arrows or flow
|
||||
- **Text**: Minimal labels, large readable fonts
|
||||
- Log: `[HH:MM:SS] GENERATED: Graphical abstract for paper summary`
|
||||
|
||||
### Additional Figures (GENERATE EXTENSIVELY)
|
||||
|
||||
**⚠️ CRITICAL: Use BOTH scientific-schematics AND generate-image EXTENSIVELY throughout all documents.**
|
||||
|
||||
Every document should be richly illustrated. Generate figures liberally - when in doubt, add a visual.
|
||||
|
||||
**MINIMUM Figure Requirements:**
|
||||
|
||||
| Document Type | Minimum | Recommended |
|
||||
|--------------|---------|-------------|
|
||||
| Research Papers | 5 | 6-8 |
|
||||
| Literature Reviews | 4 | 5-7 |
|
||||
| Market Research | 20 | 25-30 |
|
||||
| Presentations | 1/slide | 1-2/slide |
|
||||
| Posters | 6 | 8-10 |
|
||||
| Grants | 4 | 5-7 |
|
||||
| Clinical Reports | 3 | 4-6 |
|
||||
|
||||
**Use scientific-schematics EXTENSIVELY for technical diagrams:**
|
||||
```bash
|
||||
python scripts/generate_schematic.py "your diagram description" -o figures/output.png
|
||||
```
|
||||
|
||||
- Study design and methodology flowcharts (CONSORT, PRISMA, STROBE)
|
||||
- Conceptual framework diagrams
|
||||
- Experimental workflow illustrations
|
||||
- Data analysis pipeline diagrams
|
||||
- Biological pathway or mechanism diagrams
|
||||
- System architecture visualizations
|
||||
- Neural network architectures
|
||||
- Decision trees, algorithm flowcharts
|
||||
- Comparison matrices, timeline diagrams
|
||||
- Any technical concept that benefits from schematic visualization
|
||||
|
||||
**Use generate-image EXTENSIVELY for visual content:**
|
||||
```bash
|
||||
python scripts/generate_image.py "your image description" -o figures/output.png
|
||||
```
|
||||
|
||||
- Photorealistic illustrations of concepts
|
||||
- Medical/anatomical illustrations
|
||||
- Environmental/ecological scenes
|
||||
- Equipment and lab setup visualizations
|
||||
- Artistic visualizations, infographics
|
||||
- Cover images, header graphics
|
||||
- Product mockups, prototype visualizations
|
||||
- Any visual that enhances understanding or engagement
|
||||
|
||||
The AI will automatically:
|
||||
- Create publication-quality images with proper formatting
|
||||
- Review and refine through multiple iterations
|
||||
- Ensure accessibility (colorblind-friendly, high contrast)
|
||||
- Save outputs in the figures/ directory
|
||||
|
||||
**When to add schematics:**
|
||||
- Study design and methodology flowcharts (CONSORT, PRISMA, STROBE)
|
||||
- Conceptual framework diagrams
|
||||
- Experimental workflow illustrations
|
||||
- Data analysis pipeline diagrams
|
||||
- Biological pathway or mechanism diagrams
|
||||
- System architecture visualizations
|
||||
- Any complex concept that benefits from visualization
|
||||
**When in Doubt, Generate a Figure:**
|
||||
- Complex concept → generate a schematic
|
||||
- Data discussion → generate a visualization
|
||||
- Process description → generate a flowchart
|
||||
- Comparison → generate a comparison diagram
|
||||
- Reader benefit → generate a visual
|
||||
|
||||
For detailed guidance on creating schematics, refer to the scientific-schematics skill documentation.
|
||||
For detailed guidance, refer to the scientific-schematics and generate-image skill documentation.
|
||||
|
||||
---
|
||||
|
||||
@@ -294,6 +351,11 @@ Lists may appear in scientific papers only in specific contexts:
|
||||
- **Supplementary Materials**: Extended protocols, equipment lists, detailed parameters
|
||||
- **Never in**: Abstract, Introduction, Results, Discussion, Conclusions
|
||||
|
||||
**Abstract Format Rule:**
|
||||
- ❌ **NEVER** use labeled sections (Background:, Methods:, Results:, Conclusions:)
|
||||
- ✅ **ALWAYS** write as flowing paragraph(s) with natural transitions
|
||||
- Exception: Only use structured format if journal explicitly requires it in author guidelines
|
||||
|
||||
**Integration with Research Lookup:**
|
||||
|
||||
The research-lookup skill is essential for Stage 1 (creating outlines):
|
||||
@@ -308,7 +370,123 @@ This two-stage process ensures you:
|
||||
- Produce polished, publication-ready prose
|
||||
- Maintain focus on the narrative flow
|
||||
|
||||
### 8. Journal-Specific Formatting
|
||||
### 8. Professional Report Formatting (Non-Journal Documents)
|
||||
|
||||
For research reports, technical reports, white papers, and other professional documents that are NOT journal manuscripts, use the `scientific_report.sty` LaTeX style package for a polished, professional appearance.
|
||||
|
||||
**When to Use Professional Report Formatting:**
|
||||
- Research reports and technical reports
|
||||
- White papers and policy briefs
|
||||
- Grant reports and progress reports
|
||||
- Industry reports and technical documentation
|
||||
- Internal research summaries
|
||||
- Feasibility studies and project deliverables
|
||||
|
||||
**When NOT to Use (Use Venue-Specific Formatting Instead):**
|
||||
- Journal manuscripts → Use `venue-templates` skill
|
||||
- Conference papers → Use `venue-templates` skill
|
||||
- Academic theses → Use institutional templates
|
||||
|
||||
**The `scientific_report.sty` Style Package Provides:**
|
||||
|
||||
| Feature | Description |
|
||||
|---------|-------------|
|
||||
| Typography | Helvetica font family for modern, professional appearance |
|
||||
| Color Scheme | Professional blues, greens, and accent colors |
|
||||
| Box Environments | Colored boxes for key findings, methods, recommendations, limitations |
|
||||
| Tables | Alternating row colors, professional headers |
|
||||
| Figures | Consistent caption formatting |
|
||||
| Scientific Commands | Shortcuts for p-values, effect sizes, confidence intervals |
|
||||
|
||||
**Box Environments for Content Organization:**
|
||||
|
||||
```latex
|
||||
% Key findings (blue) - for major discoveries
|
||||
\begin{keyfindings}[Title]
|
||||
Content with key findings and statistics.
|
||||
\end{keyfindings}
|
||||
|
||||
% Methodology (green) - for methods highlights
|
||||
\begin{methodology}[Study Design]
|
||||
Description of methods and procedures.
|
||||
\end{methodology}
|
||||
|
||||
% Recommendations (purple) - for action items
|
||||
\begin{recommendations}[Clinical Implications]
|
||||
\begin{enumerate}
|
||||
\item Specific recommendation 1
|
||||
\item Specific recommendation 2
|
||||
\end{enumerate}
|
||||
\end{recommendations}
|
||||
|
||||
% Limitations (orange) - for caveats and cautions
|
||||
\begin{limitations}[Study Limitations]
|
||||
Description of limitations and their implications.
|
||||
\end{limitations}
|
||||
```
|
||||
|
||||
**Professional Table Formatting:**
|
||||
|
||||
```latex
|
||||
\begin{table}[htbp]
|
||||
\centering
|
||||
\caption{Results Summary}
|
||||
\begin{tabular}{@{}lccc@{}}
|
||||
\toprule
|
||||
\textbf{Variable} & \textbf{Treatment} & \textbf{Control} & \textbf{p} \\
|
||||
\midrule
|
||||
Outcome 1 & \meansd{42.5}{8.3} & \meansd{35.2}{7.9} & <.001\sigthree \\
|
||||
\rowcolor{tablealt} Outcome 2 & \meansd{3.8}{1.2} & \meansd{3.1}{1.1} & .012\sigone \\
|
||||
Outcome 3 & \meansd{18.2}{4.5} & \meansd{17.8}{4.2} & .58\signs \\
|
||||
\bottomrule
|
||||
\end{tabular}
|
||||
|
||||
{\small \siglegend}
|
||||
\end{table}
|
||||
```
|
||||
|
||||
**Scientific Notation Commands:**
|
||||
|
||||
| Command | Output | Purpose |
|
||||
|---------|--------|---------|
|
||||
| `\pvalue{0.023}` | *p* = 0.023 | P-values |
|
||||
| `\psig{< 0.001}` | ***p* = < 0.001** | Significant p-values (bold) |
|
||||
| `\CI{0.45}{0.72}` | 95% CI [0.45, 0.72] | Confidence intervals |
|
||||
| `\effectsize{d}{0.75}` | d = 0.75 | Effect sizes |
|
||||
| `\samplesize{250}` | *n* = 250 | Sample sizes |
|
||||
| `\meansd{42.5}{8.3}` | 42.5 ± 8.3 | Mean with SD |
|
||||
| `\sigone`, `\sigtwo`, `\sigthree` | *, **, *** | Significance stars |
|
||||
|
||||
**Getting Started:**
|
||||
|
||||
```latex
|
||||
\documentclass[11pt,letterpaper]{report}
|
||||
\usepackage{scientific_report}
|
||||
|
||||
\begin{document}
|
||||
\makereporttitle
|
||||
{Report Title}
|
||||
{Subtitle}
|
||||
{Author Name}
|
||||
{Institution}
|
||||
{Date}
|
||||
|
||||
% Your content with professional formatting
|
||||
\end{document}
|
||||
```
|
||||
|
||||
**Compilation**: Use XeLaTeX or LuaLaTeX for proper Helvetica font rendering:
|
||||
```bash
|
||||
xelatex report.tex
|
||||
```
|
||||
|
||||
For complete documentation, refer to:
|
||||
- `assets/scientific_report.sty`: The style package
|
||||
- `assets/scientific_report_template.tex`: Complete template example
|
||||
- `assets/REPORT_FORMATTING_GUIDE.md`: Quick reference guide
|
||||
- `references/professional_report_formatting.md`: Comprehensive formatting guide
|
||||
|
||||
### 9. Journal-Specific Formatting
|
||||
|
||||
Adapt manuscripts to journal requirements:
|
||||
- Follow author guidelines for structure, length, and format
|
||||
@@ -318,7 +496,7 @@ Adapt manuscripts to journal requirements:
|
||||
- Adhere to word limits for each section
|
||||
- Format according to template requirements when provided
|
||||
|
||||
### 9. Field-Specific Language and Terminology
|
||||
### 10. Field-Specific Language and Terminology
|
||||
|
||||
Adapt language, terminology, and conventions to match the specific scientific discipline. Each field has established vocabulary, preferred phrasings, and domain-specific conventions that signal expertise and ensure clarity for the target audience.
|
||||
|
||||
@@ -408,7 +586,7 @@ Adapt language, terminology, and conventions to match the specific scientific di
|
||||
- Use domain-specific databases and ontologies (e.g., Gene Ontology, MeSH terms)
|
||||
- When uncertain, cite a key reference that establishes terminology
|
||||
|
||||
### 10. Common Pitfalls to Avoid
|
||||
### 11. Common Pitfalls to Avoid
|
||||
|
||||
**Top Rejection Reasons:**
|
||||
1. Inappropriate, incomplete, or insufficiently described statistics
|
||||
@@ -472,6 +650,40 @@ This skill works effectively with:
|
||||
- **Statistical analysis**: For determining appropriate statistical presentations
|
||||
- **Literature review skills**: For contextualizing research
|
||||
- **Figure creation tools**: For developing publication-quality visualizations
|
||||
- **Venue-templates skill**: For venue-specific writing styles and formatting (journal manuscripts)
|
||||
- **scientific_report.sty**: For professional reports, white papers, and technical documents
|
||||
|
||||
### Professional Reports vs. Journal Manuscripts
|
||||
|
||||
**Choose the right formatting approach:**
|
||||
|
||||
| Document Type | Formatting Approach |
|
||||
|---------------|---------------------|
|
||||
| Journal manuscripts | Use `venue-templates` skill |
|
||||
| Conference papers | Use `venue-templates` skill |
|
||||
| Research reports | Use `scientific_report.sty` (this skill) |
|
||||
| White papers | Use `scientific_report.sty` (this skill) |
|
||||
| Technical reports | Use `scientific_report.sty` (this skill) |
|
||||
| Grant reports | Use `scientific_report.sty` (this skill) |
|
||||
|
||||
### Venue-Specific Writing Styles
|
||||
|
||||
**Before writing for a specific venue, consult the venue-templates skill for writing style guides:**
|
||||
|
||||
Different venues have dramatically different writing expectations:
|
||||
- **Nature/Science**: Accessible, story-driven, broad significance
|
||||
- **Cell Press**: Mechanistic depth, graphical abstracts, Highlights
|
||||
- **Medical journals (NEJM, Lancet)**: Structured abstracts, evidence language
|
||||
- **ML conferences (NeurIPS, ICML)**: Contribution bullets, ablation studies
|
||||
- **CS conferences (CHI, ACL)**: Field-specific conventions
|
||||
|
||||
The venue-templates skill provides:
|
||||
- `venue_writing_styles.md`: Master style comparison
|
||||
- Venue-specific guides: `nature_science_style.md`, `cell_press_style.md`, `medical_journal_styles.md`, `ml_conference_style.md`, `cs_conference_style.md`
|
||||
- `reviewer_expectations.md`: What reviewers look for at each venue
|
||||
- Writing examples in `assets/examples/`
|
||||
|
||||
**Workflow**: First use this skill for general scientific writing principles (IMRAD, clarity, citations), then consult venue-templates for venue-specific style adaptation.
|
||||
|
||||
## References
|
||||
|
||||
@@ -482,6 +694,25 @@ This skill includes comprehensive reference files covering specific aspects of s
|
||||
- `references/figures_tables.md`: Best practices for creating effective data visualizations
|
||||
- `references/reporting_guidelines.md`: Study-specific reporting standards and checklists
|
||||
- `references/writing_principles.md`: Core principles of effective scientific communication
|
||||
- `references/professional_report_formatting.md`: Guide to professional report styling with `scientific_report.sty`
|
||||
|
||||
## Assets
|
||||
|
||||
This skill includes LaTeX style packages and templates for professional report formatting:
|
||||
|
||||
- `assets/scientific_report.sty`: Professional LaTeX style package with Helvetica fonts, colored boxes, and attractive tables
|
||||
- `assets/scientific_report_template.tex`: Complete report template demonstrating all style features
|
||||
- `assets/REPORT_FORMATTING_GUIDE.md`: Quick reference guide for the style package
|
||||
|
||||
**Key Features of `scientific_report.sty`:**
|
||||
- Helvetica font family for modern, professional appearance
|
||||
- Professional color scheme (blues, greens, oranges, purples)
|
||||
- Box environments: `keyfindings`, `methodology`, `resultsbox`, `recommendations`, `limitations`, `criticalnotice`, `definition`, `executivesummary`, `hypothesis`
|
||||
- Tables with alternating row colors and professional headers
|
||||
- Scientific notation commands for p-values, effect sizes, confidence intervals
|
||||
- Professional headers and footers
|
||||
|
||||
**For venue-specific writing styles** (tone, voice, abstract format, reviewer expectations), see the **venue-templates** skill which provides comprehensive style guides for Nature/Science, Cell Press, medical journals, ML conferences, and CS conferences.
|
||||
|
||||
Load these references as needed when working on specific aspects of scientific writing.
|
||||
|
||||
|
||||
@@ -0,0 +1,574 @@
|
||||
# Scientific Report Formatting Guide
|
||||
|
||||
Quick reference for using the `scientific_report.sty` style package.
|
||||
|
||||
## Overview
|
||||
|
||||
The `scientific_report.sty` package provides professional formatting for scientific reports, technical documents, and white papers. It features:
|
||||
|
||||
- **Helvetica font family** for a clean, modern appearance
|
||||
- **Professional color scheme** with blues, greens, and accent colors
|
||||
- **Colored box environments** for organizing different types of content
|
||||
- **Attractive tables** with alternating row colors and professional headers
|
||||
- **Scientific notation commands** for p-values, effect sizes, and statistics
|
||||
- **Professional headers and footers** with automatic section titles
|
||||
|
||||
---
|
||||
|
||||
## Color Palette
|
||||
|
||||
### Primary Colors (Blues)
|
||||
|
||||
| Color Name | RGB | Hex | Usage |
|
||||
|------------|-----|-----|-------|
|
||||
| `primaryblue` | (0, 51, 102) | `#003366` | Headers, titles, primary elements |
|
||||
| `secondaryblue` | (74, 144, 226) | `#4A90E2` | Subsections, secondary headings |
|
||||
| `lightblue` | (220, 235, 252) | `#DCEBFC` | Key findings box backgrounds |
|
||||
| `accentblue` | (0, 120, 215) | `#0078D7` | Accent highlights, hypothesis boxes |
|
||||
|
||||
### Scientific Colors (Greens)
|
||||
|
||||
| Color Name | RGB | Hex | Usage |
|
||||
|------------|-----|-----|-------|
|
||||
| `sciencegreen` | (0, 168, 150) | `#00A896` | Methodology boxes, positive findings |
|
||||
| `lightgreen` | (220, 245, 240) | `#DCF5F0` | Methodology box backgrounds |
|
||||
| `darkgreen` | (0, 128, 96) | `#008060` | Results boxes, strong evidence |
|
||||
|
||||
### Warning Colors (Orange/Red)
|
||||
|
||||
| Color Name | RGB | Hex | Usage |
|
||||
|------------|-----|-----|-------|
|
||||
| `cautionorange` | (255, 140, 66) | `#FF8C42` | Limitations, warnings, cautions |
|
||||
| `lightorange` | (255, 243, 224) | `#FFF3E0` | Limitations box backgrounds |
|
||||
| `criticalred` | (198, 40, 40) | `#C62828` | Critical notices, alerts |
|
||||
| `lightred` | (255, 235, 238) | `#FFEBEE` | Critical notice backgrounds |
|
||||
|
||||
### Recommendation Colors
|
||||
|
||||
| Color Name | RGB | Hex | Usage |
|
||||
|------------|-----|-----|-------|
|
||||
| `recommendpurple` | (103, 58, 183) | `#673AB7` | Recommendations boxes |
|
||||
| `lightpurple` | (237, 231, 246) | `#EDE7F6` | Recommendations box backgrounds |
|
||||
|
||||
### Neutral Colors
|
||||
|
||||
| Color Name | RGB | Hex | Usage |
|
||||
|------------|-----|-----|-------|
|
||||
| `darkgray` | (66, 66, 66) | `#424242` | Body text |
|
||||
| `mediumgray` | (117, 117, 117) | `#757575` | Secondary text, definitions |
|
||||
| `lightgray` | (245, 245, 245) | `#F5F5F5` | Backgrounds, definition boxes |
|
||||
| `tablealt` | (248, 250, 252) | `#F8FAFC` | Alternating table rows |
|
||||
|
||||
---
|
||||
|
||||
## Box Environments
|
||||
|
||||
### Key Findings Box (Blue)
|
||||
|
||||
For major findings, discoveries, and important results.
|
||||
|
||||
```latex
|
||||
\begin{keyfindings}[Custom Title]
|
||||
This study found that treatment A significantly outperformed
|
||||
treatment B (\pvalue{0.001}, \effectsize{d}{0.75}).
|
||||
\end{keyfindings}
|
||||
```
|
||||
|
||||
### Methodology Box (Green)
|
||||
|
||||
For methods, procedures, and study design highlights.
|
||||
|
||||
```latex
|
||||
\begin{methodology}[Study Design]
|
||||
This randomized controlled trial employed a 2×2 factorial design
|
||||
with pre-post measurements and 6-month follow-up.
|
||||
\end{methodology}
|
||||
```
|
||||
|
||||
### Results Box (Blue-Green)
|
||||
|
||||
For highlighting specific results and statistical findings.
|
||||
|
||||
```latex
|
||||
\begin{resultsbox}[Primary Outcome]
|
||||
Analysis revealed a significant main effect, F(2, 147) = 12.45,
|
||||
\psig{< 0.001}, $\eta^2$ = 0.145.
|
||||
\end{resultsbox}
|
||||
```
|
||||
|
||||
### Recommendations Box (Purple)
|
||||
|
||||
For recommendations, implications, and action items.
|
||||
|
||||
```latex
|
||||
\begin{recommendations}[Clinical Implications]
|
||||
\begin{enumerate}
|
||||
\item Implement screening protocol for high-risk patients
|
||||
\item Adjust treatment dosage based on biomarker levels
|
||||
\item Monitor patients at 3-month intervals
|
||||
\end{enumerate}
|
||||
\end{recommendations}
|
||||
```
|
||||
|
||||
### Limitations Box (Orange)
|
||||
|
||||
For limitations, cautions, and caveats.
|
||||
|
||||
```latex
|
||||
\begin{limitations}[Study Limitations]
|
||||
\begin{itemize}
|
||||
\item Sample limited to urban populations
|
||||
\item Cross-sectional design precludes causal inference
|
||||
\item Self-report measures may introduce bias
|
||||
\end{itemize}
|
||||
\end{limitations}
|
||||
```
|
||||
|
||||
### Critical Notice Box (Red)
|
||||
|
||||
For critical warnings, important notices, or safety information.
|
||||
|
||||
```latex
|
||||
\begin{criticalnotice}[Safety Warning]
|
||||
Patients with contraindication X should not receive this treatment.
|
||||
Consult specialist before proceeding.
|
||||
\end{criticalnotice}
|
||||
```
|
||||
|
||||
### Definition Box (Gray)
|
||||
|
||||
For definitions, notes, and supplementary information.
|
||||
|
||||
```latex
|
||||
\begin{definition}[Key Term]
|
||||
\textbf{Effect size} refers to a quantitative measure of the
|
||||
magnitude of a phenomenon, independent of sample size.
|
||||
\end{definition}
|
||||
```
|
||||
|
||||
### Executive Summary Box (Special)
|
||||
|
||||
For executive summaries with enhanced styling and shadow effect.
|
||||
|
||||
```latex
|
||||
\begin{executivesummary}[Report Overview]
|
||||
This report presents findings from a comprehensive analysis
|
||||
of [topic]. Key findings indicate that...
|
||||
\end{executivesummary}
|
||||
```
|
||||
|
||||
### Hypothesis Box (Light Blue)
|
||||
|
||||
For stating research hypotheses.
|
||||
|
||||
```latex
|
||||
\begin{hypothesis}[Primary Hypothesis]
|
||||
We hypothesize that intervention X will significantly improve
|
||||
outcome Y compared to control conditions.
|
||||
\end{hypothesis}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Pull Quotes
|
||||
|
||||
For highlighting important quotes or statements.
|
||||
|
||||
```latex
|
||||
\begin{pullquote}
|
||||
"These findings represent a paradigm shift in our understanding
|
||||
of the underlying mechanisms."
|
||||
\end{pullquote}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Statistic Boxes
|
||||
|
||||
For highlighting key statistics (use in rows of 3).
|
||||
|
||||
```latex
|
||||
\begin{center}
|
||||
\statbox{n = 500}{Participants}
|
||||
\statbox{p < 0.001}{Significance}
|
||||
\statbox{d = 0.75}{Effect Size}
|
||||
\end{center}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Scientific Notation Commands
|
||||
|
||||
### P-Values
|
||||
|
||||
```latex
|
||||
\pvalue{0.023} % Outputs: p = 0.023
|
||||
\psig{< 0.001} % Outputs: p = < 0.001 (bold for significant)
|
||||
```
|
||||
|
||||
### Confidence Intervals
|
||||
|
||||
```latex
|
||||
\CI{0.45}{0.72} % Outputs: 95% CI [0.45, 0.72]
|
||||
```
|
||||
|
||||
### Effect Sizes
|
||||
|
||||
```latex
|
||||
\effectsize{d}{0.75} % Outputs: d = 0.75
|
||||
\effectsize{r}{0.42} % Outputs: r = 0.42
|
||||
\effectsize{F(2, 97)}{12.45} % Outputs: F(2, 97) = 12.45
|
||||
```
|
||||
|
||||
### Sample Size
|
||||
|
||||
```latex
|
||||
\samplesize{250} % Outputs: n = 250
|
||||
```
|
||||
|
||||
### Mean with Standard Deviation
|
||||
|
||||
```latex
|
||||
\meansd{42.5}{8.3} % Outputs: 42.5 ± 8.3
|
||||
```
|
||||
|
||||
### Significance Indicators (for tables)
|
||||
|
||||
```latex
|
||||
Result\sigone % * for p < 0.05
|
||||
Result\sigtwo % ** for p < 0.01
|
||||
Result\sigthree % *** for p < 0.001
|
||||
Result\signs % ns for not significant
|
||||
|
||||
% Legend for table footnotes:
|
||||
\siglegend % Outputs: *p < 0.05; **p < 0.01; ***p < 0.001; ns not significant
|
||||
```
|
||||
|
||||
### Quality/Evidence Indicators
|
||||
|
||||
```latex
|
||||
\qualityhigh % HIGH (green)
|
||||
\qualitymedium % MEDIUM (orange)
|
||||
\qualitylow % LOW (red)
|
||||
|
||||
\evidencestrong % Strong (green)
|
||||
\evidencemoderate % Moderate (orange)
|
||||
\evidenceweak % Weak (red)
|
||||
```
|
||||
|
||||
### Trend Indicators
|
||||
|
||||
```latex
|
||||
\trendup % Green up triangle ▲
|
||||
\trenddown % Red down triangle ▼
|
||||
\trendflat % Gray right arrow →
|
||||
```
|
||||
|
||||
### Text Highlighting
|
||||
|
||||
```latex
|
||||
\highlight{important text} % Blue bold text
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Table Formatting
|
||||
|
||||
### Standard Table with Alternating Rows
|
||||
|
||||
```latex
|
||||
\begin{table}[htbp]
|
||||
\centering
|
||||
\caption{Descriptive Statistics by Group}
|
||||
\label{tab:descriptives}
|
||||
\begin{tabular}{@{}lccc@{}}
|
||||
\toprule
|
||||
\textbf{Variable} & \textbf{Group A} & \textbf{Group B} & \textbf{p} \\
|
||||
\midrule
|
||||
Age (years) & \meansd{42.5}{8.3} & \meansd{43.1}{7.9} & .58 \\
|
||||
\rowcolor{tablealt} Score 1 & \meansd{15.2}{3.4} & \meansd{18.7}{4.1} & <.001\sigthree \\
|
||||
Score 2 & \meansd{22.8}{5.1} & \meansd{23.4}{4.8} & .42 \\
|
||||
\rowcolor{tablealt} Score 3 & \meansd{8.9}{2.2} & \meansd{7.2}{2.5} & .003\sigtwo \\
|
||||
\bottomrule
|
||||
\end{tabular}
|
||||
|
||||
\vspace{0.5em}
|
||||
{\small \siglegend}
|
||||
\end{table}
|
||||
```
|
||||
|
||||
### Table with Quality Indicators
|
||||
|
||||
```latex
|
||||
\begin{tabular}{@{}llcc@{}}
|
||||
\toprule
|
||||
\textbf{Study} & \textbf{Design} & \textbf{Quality} & \textbf{Evidence} \\
|
||||
\midrule
|
||||
Smith et al. (2023) & RCT & \qualityhigh & \evidencestrong \\
|
||||
\rowcolor{tablealt} Jones et al. (2022) & Cohort & \qualitymedium & \evidencemoderate \\
|
||||
Lee et al. (2021) & Cross-sectional & \qualitylow & \evidenceweak \\
|
||||
\bottomrule
|
||||
\end{tabular}
|
||||
```
|
||||
|
||||
### Table with Trend Indicators
|
||||
|
||||
```latex
|
||||
\begin{tabular}{@{}lrrl@{}}
|
||||
\toprule
|
||||
\textbf{Metric} & \textbf{Baseline} & \textbf{Follow-up} & \textbf{Change} \\
|
||||
\midrule
|
||||
Score A & 42.5 & 58.3 & \trendup +37\% \\
|
||||
\rowcolor{tablealt} Score B & 18.2 & 15.1 & \trenddown -17\% \\
|
||||
Score C & 7.8 & 7.9 & \trendflat +1\% \\
|
||||
\bottomrule
|
||||
\end{tabular}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Figure Formatting
|
||||
|
||||
### Standard Figure
|
||||
|
||||
```latex
|
||||
\begin{figure}[htbp]
|
||||
\centering
|
||||
\includegraphics[width=0.9\textwidth]{../figures/results_chart.png}
|
||||
\caption{Comparison of Outcome Scores Across Treatment Conditions}
|
||||
\label{fig:results}
|
||||
\end{figure}
|
||||
```
|
||||
|
||||
### Figure with Source Attribution
|
||||
|
||||
```latex
|
||||
\begin{figure}[htbp]
|
||||
\centering
|
||||
\includegraphics[width=0.85\textwidth]{../figures/data_visualization.png}
|
||||
\caption{Distribution of Participant Responses by Category}
|
||||
\figuresource{Study data, collected January-March 2024}
|
||||
\label{fig:distribution}
|
||||
\end{figure}
|
||||
```
|
||||
|
||||
### Figure with Note
|
||||
|
||||
```latex
|
||||
\begin{figure}[htbp]
|
||||
\centering
|
||||
\includegraphics[width=0.8\textwidth]{../figures/model_diagram.png}
|
||||
\caption{Conceptual Model of Proposed Relationships}
|
||||
\figurenote{Solid arrows indicate direct effects; dashed arrows indicate moderated effects.}
|
||||
\label{fig:model}
|
||||
\end{figure}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Title Page
|
||||
|
||||
### Standard Title Page
|
||||
|
||||
```latex
|
||||
\makereporttitle
|
||||
{Research Report Title} % Title
|
||||
{A Comprehensive Analysis} % Subtitle
|
||||
{Author Name, PhD} % Author(s)
|
||||
{Research Institution} % Institution
|
||||
{January 2025} % Date
|
||||
```
|
||||
|
||||
### Title Page with Cover Image
|
||||
|
||||
```latex
|
||||
\makereporttitlewithimage
|
||||
{Research Report Title} % Title
|
||||
{A Comprehensive Analysis} % Subtitle
|
||||
{../figures/cover_image.png} % Image path
|
||||
{Author Name, PhD} % Author(s)
|
||||
{Research Institution} % Institution
|
||||
{January 2025} % Date
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## List Formatting
|
||||
|
||||
Lists automatically use blue bullets/numbers.
|
||||
|
||||
### Bullet Lists
|
||||
|
||||
```latex
|
||||
\begin{itemize}
|
||||
\item First item with automatic blue bullet
|
||||
\item Second item
|
||||
\item Third item
|
||||
\end{itemize}
|
||||
```
|
||||
|
||||
### Numbered Lists
|
||||
|
||||
```latex
|
||||
\begin{enumerate}
|
||||
\item First item with blue number
|
||||
\item Second item
|
||||
\item Third item
|
||||
\end{enumerate}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Appendix Sections
|
||||
|
||||
```latex
|
||||
\appendix
|
||||
|
||||
\chapter{Supplementary Materials}
|
||||
|
||||
\appendixsection{Additional Tables}
|
||||
% Content appears in table of contents
|
||||
|
||||
\appendixsection{Instruments}
|
||||
% Additional appendix content
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Compilation
|
||||
|
||||
Compile with XeLaTeX or LuaLaTeX for best font rendering:
|
||||
|
||||
```bash
|
||||
# Using XeLaTeX
|
||||
xelatex report.tex
|
||||
bibtex report # If using BibTeX
|
||||
xelatex report.tex
|
||||
xelatex report.tex
|
||||
|
||||
# Using latexmk (recommended)
|
||||
latexmk -xelatex report.tex
|
||||
|
||||
# Using LuaLaTeX
|
||||
lualatex report.tex
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Patterns
|
||||
|
||||
### Results Section Example
|
||||
|
||||
```latex
|
||||
\section{Primary Outcomes}
|
||||
|
||||
\begin{resultsbox}[Main Finding]
|
||||
The intervention group showed significantly higher scores than
|
||||
the control group, \effectsize{t(98)}{3.45}, \psig{< 0.001},
|
||||
\effectsize{d}{0.69}, \CI{0.42}{0.96}.
|
||||
\end{resultsbox}
|
||||
|
||||
Table~\ref{tab:outcomes} presents the complete results for all
|
||||
outcome measures.
|
||||
|
||||
\begin{table}[htbp]
|
||||
\centering
|
||||
\caption{Outcome Measures by Treatment Condition}
|
||||
\label{tab:outcomes}
|
||||
\begin{tabular}{@{}lcccc@{}}
|
||||
\toprule
|
||||
\textbf{Measure} & \textbf{Control} & \textbf{Treatment} & \textbf{d} & \textbf{p} \\
|
||||
\midrule
|
||||
Primary & \meansd{42.1}{8.2} & \meansd{51.3}{9.1} & 0.69\sigthree & <.001 \\
|
||||
\rowcolor{tablealt} Secondary & \meansd{3.2}{1.1} & \meansd{4.1}{1.3} & 0.52\sigtwo & .004 \\
|
||||
Tertiary & \meansd{18.5}{4.2} & \meansd{19.2}{4.5} & 0.16\signs & .328 \\
|
||||
\bottomrule
|
||||
\end{tabular}
|
||||
\end{table}
|
||||
```
|
||||
|
||||
### Discussion Section Example
|
||||
|
||||
```latex
|
||||
\section{Interpretation of Findings}
|
||||
|
||||
\begin{keyfindings}[Summary]
|
||||
\begin{enumerate}
|
||||
\item Primary hypothesis \highlight{supported} with large effect
|
||||
\item Secondary hypothesis partially supported
|
||||
\item Evidence quality: \evidencestrong
|
||||
\end{enumerate}
|
||||
\end{keyfindings}
|
||||
|
||||
\begin{limitations}
|
||||
This study has several limitations that should be considered...
|
||||
\end{limitations}
|
||||
|
||||
\begin{recommendations}[Future Research]
|
||||
Future studies should address the following:
|
||||
\begin{enumerate}
|
||||
\item Replicate findings in diverse populations
|
||||
\item Extend follow-up period to assess long-term effects
|
||||
\item Investigate moderating variables
|
||||
\end{enumerate}
|
||||
\end{recommendations}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Box Overflow
|
||||
If box content overflows the page:
|
||||
```latex
|
||||
\newpage
|
||||
\begin{keyfindings}[Continued...]
|
||||
```
|
||||
|
||||
### Figure Placement
|
||||
Use `[htbp]` for flexible placement, or `[H]` (requires `float` package) for exact:
|
||||
```latex
|
||||
\usepackage{float}
|
||||
\begin{figure}[H]
|
||||
```
|
||||
|
||||
### Table Too Wide
|
||||
Use `\resizebox` or reduce font size:
|
||||
```latex
|
||||
\resizebox{\textwidth}{!}{
|
||||
\begin{tabular}{...}
|
||||
...
|
||||
\end{tabular}
|
||||
}
|
||||
```
|
||||
|
||||
### Font Issues
|
||||
If Helvetica isn't rendering, ensure you're using XeLaTeX or LuaLaTeX:
|
||||
```bash
|
||||
xelatex report.tex # NOT pdflatex
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Quick Reference Card
|
||||
|
||||
| Purpose | Command/Environment |
|
||||
|---------|---------------------|
|
||||
| Major finding | `\begin{keyfindings}...\end{keyfindings}` |
|
||||
| Methods | `\begin{methodology}...\end{methodology}` |
|
||||
| Results | `\begin{resultsbox}...\end{resultsbox}` |
|
||||
| Recommendation | `\begin{recommendations}...\end{recommendations}` |
|
||||
| Limitation | `\begin{limitations}...\end{limitations}` |
|
||||
| Warning | `\begin{criticalnotice}...\end{criticalnotice}` |
|
||||
| Definition | `\begin{definition}...\end{definition}` |
|
||||
| Executive summary | `\begin{executivesummary}...\end{executivesummary}` |
|
||||
| Hypothesis | `\begin{hypothesis}...\end{hypothesis}` |
|
||||
| P-value | `\pvalue{0.05}` or `\psig{< 0.001}` |
|
||||
| Effect size | `\effectsize{d}{0.75}` |
|
||||
| Sample size | `\samplesize{250}` |
|
||||
| Mean ± SD | `\meansd{42.5}{8.3}` |
|
||||
| CI | `\CI{0.38}{0.72}` |
|
||||
| Highlight | `\highlight{text}` |
|
||||
| Alt row | `\rowcolor{tablealt}` |
|
||||
| Significance | `\sigone`, `\sigtwo`, `\sigthree`, `\signs` |
|
||||
|
||||
@@ -0,0 +1,606 @@
|
||||
% scientific_report.sty - Professional Scientific Report Styling
|
||||
% For use with XeLaTeX or LuaLaTeX
|
||||
% Designed for research reports, technical reports, white papers, and similar documents
|
||||
% NOT for journal manuscripts (use venue-templates for those)
|
||||
|
||||
\ProvidesPackage{scientific_report}[2024/01/01 Scientific Report Style]
|
||||
|
||||
% ============================================================================
|
||||
% REQUIRED PACKAGES
|
||||
% ============================================================================
|
||||
|
||||
% Page layout and geometry
|
||||
\RequirePackage[margin=1in, headheight=14pt]{geometry}
|
||||
\RequirePackage{setspace}
|
||||
|
||||
% Typography - Helvetica font family
|
||||
\RequirePackage[utf8]{inputenc}
|
||||
\RequirePackage[T1]{fontenc}
|
||||
\RequirePackage{helvet}
|
||||
\renewcommand{\familydefault}{\sfdefault}
|
||||
|
||||
% Colors and graphics
|
||||
\RequirePackage{xcolor}
|
||||
\RequirePackage{graphicx}
|
||||
\RequirePackage{tikz}
|
||||
|
||||
% Tables
|
||||
\RequirePackage{longtable}
|
||||
\RequirePackage{booktabs}
|
||||
\RequirePackage{multirow}
|
||||
\RequirePackage{array}
|
||||
\RequirePackage{colortbl}
|
||||
\RequirePackage{tabularx}
|
||||
|
||||
% Lists and formatting
|
||||
\RequirePackage{enumitem}
|
||||
\RequirePackage{parskip}
|
||||
|
||||
% Boxes and callouts
|
||||
\RequirePackage[most]{tcolorbox}
|
||||
|
||||
% Headers and footers
|
||||
\RequirePackage{fancyhdr}
|
||||
\RequirePackage{titlesec}
|
||||
|
||||
% Hyperlinks and references
|
||||
\RequirePackage{hyperref}
|
||||
\RequirePackage[numbers,sort&compress]{natbib}
|
||||
|
||||
% Math and scientific notation
|
||||
\RequirePackage{amsmath}
|
||||
\RequirePackage{amssymb}
|
||||
\RequirePackage{siunitx}
|
||||
|
||||
% Captions
|
||||
\RequirePackage{caption}
|
||||
\RequirePackage{subcaption}
|
||||
|
||||
% ============================================================================
|
||||
% COLOR DEFINITIONS - PROFESSIONAL SCIENTIFIC PALETTE
|
||||
% ============================================================================
|
||||
|
||||
% Primary colors (professional blue palette)
|
||||
\definecolor{primaryblue}{RGB}{0, 51, 102} % Deep navy blue - headers, titles
|
||||
\definecolor{secondaryblue}{RGB}{74, 144, 226} % Medium blue - subsections
|
||||
\definecolor{lightblue}{RGB}{220, 235, 252} % Light blue for backgrounds
|
||||
\definecolor{accentblue}{RGB}{0, 120, 215} % Bright accent blue
|
||||
|
||||
% Scientific accent colors
|
||||
\definecolor{sciencegreen}{RGB}{0, 168, 150} % Teal green - positive findings
|
||||
\definecolor{lightgreen}{RGB}{220, 245, 240} % Light green background
|
||||
\definecolor{darkgreen}{RGB}{0, 128, 96} % Dark green for emphasis
|
||||
|
||||
% Warning and caution colors
|
||||
\definecolor{cautionorange}{RGB}{255, 140, 66} % Orange for warnings/limitations
|
||||
\definecolor{lightorange}{RGB}{255, 243, 224} % Light orange background
|
||||
\definecolor{criticalred}{RGB}{198, 40, 40} % Red for critical items
|
||||
\definecolor{lightred}{RGB}{255, 235, 238} % Light red background
|
||||
|
||||
% Recommendation and action colors
|
||||
\definecolor{recommendpurple}{RGB}{103, 58, 183} % Purple for recommendations
|
||||
\definecolor{lightpurple}{RGB}{237, 231, 246} % Light purple background
|
||||
|
||||
% Neutral colors
|
||||
\definecolor{darkgray}{RGB}{66, 66, 66} % Dark gray for body text
|
||||
\definecolor{mediumgray}{RGB}{117, 117, 117} % Medium gray for secondary text
|
||||
\definecolor{lightgray}{RGB}{245, 245, 245} % Light gray backgrounds
|
||||
\definecolor{tablealt}{RGB}{248, 250, 252} % Alternating table row color
|
||||
\definecolor{tableborder}{RGB}{200, 200, 200} % Table border color
|
||||
|
||||
% ============================================================================
|
||||
% HYPERLINK CONFIGURATION
|
||||
% ============================================================================
|
||||
|
||||
\hypersetup{
|
||||
colorlinks=true,
|
||||
linkcolor=primaryblue,
|
||||
filecolor=primaryblue,
|
||||
urlcolor=accentblue,
|
||||
citecolor=secondaryblue,
|
||||
pdftitle={Scientific Report},
|
||||
pdfauthor={},
|
||||
pdfsubject={Scientific Research},
|
||||
}
|
||||
|
||||
% ============================================================================
|
||||
% CHAPTER AND SECTION FORMATTING
|
||||
% ============================================================================
|
||||
|
||||
% Chapter formatting - large number with colored title
|
||||
\titleformat{\chapter}[display]
|
||||
{\normalfont\huge\bfseries\color{primaryblue}}
|
||||
{\chaptertitlename\ \thechapter}{20pt}{\Huge}
|
||||
\titlespacing*{\chapter}{0pt}{-20pt}{40pt}
|
||||
|
||||
% Section formatting
|
||||
\titleformat{\section}
|
||||
{\normalfont\Large\bfseries\color{primaryblue}}
|
||||
{\thesection}{1em}{}
|
||||
\titlespacing*{\section}{0pt}{3.5ex plus 1ex minus .2ex}{2.3ex plus .2ex}
|
||||
|
||||
% Subsection formatting
|
||||
\titleformat{\subsection}
|
||||
{\normalfont\large\bfseries\color{secondaryblue}}
|
||||
{\thesubsection}{1em}{}
|
||||
|
||||
% Subsubsection formatting
|
||||
\titleformat{\subsubsection}
|
||||
{\normalfont\normalsize\bfseries\color{darkgray}}
|
||||
{\thesubsubsection}{1em}{}
|
||||
|
||||
% Paragraph formatting
|
||||
\titleformat{\paragraph}[runin]
|
||||
{\normalfont\normalsize\bfseries\color{darkgray}}
|
||||
{\theparagraph}{1em}{}
|
||||
|
||||
% ============================================================================
|
||||
% HEADER AND FOOTER CONFIGURATION
|
||||
% ============================================================================
|
||||
|
||||
\pagestyle{fancy}
|
||||
\fancyhf{}
|
||||
\fancyhead[L]{\small\textit{\leftmark}}
|
||||
\fancyhead[R]{\small\textit{Scientific Report}}
|
||||
\fancyfoot[C]{\thepage}
|
||||
\renewcommand{\headrulewidth}{0.4pt}
|
||||
\renewcommand{\footrulewidth}{0.4pt}
|
||||
\renewcommand{\headrule}{\hbox to\headwidth{\color{primaryblue}\leaders\hrule height \headrulewidth\hfill}}
|
||||
\renewcommand{\footrule}{\hbox to\headwidth{\color{lightgray}\leaders\hrule height \footrulewidth\hfill}}
|
||||
|
||||
% Plain page style for chapter pages
|
||||
\fancypagestyle{plain}{
|
||||
\fancyhf{}
|
||||
\fancyfoot[C]{\thepage}
|
||||
\renewcommand{\headrulewidth}{0pt}
|
||||
\renewcommand{\footrulewidth}{0.4pt}
|
||||
}
|
||||
|
||||
% ============================================================================
|
||||
% BOX ENVIRONMENTS - SCIENTIFIC CONTENT ORGANIZATION
|
||||
% ============================================================================
|
||||
|
||||
% Key Findings Box (Blue) - For major findings and discoveries
|
||||
\newtcolorbox{keyfindings}[1][Key Findings]{
|
||||
colback=lightblue,
|
||||
colframe=primaryblue,
|
||||
fonttitle=\bfseries\color{white},
|
||||
title=#1,
|
||||
coltitle=white,
|
||||
colbacktitle=primaryblue,
|
||||
boxrule=1pt,
|
||||
arc=3pt,
|
||||
left=10pt,
|
||||
right=10pt,
|
||||
top=8pt,
|
||||
bottom=8pt,
|
||||
before skip=12pt,
|
||||
after skip=12pt,
|
||||
}
|
||||
|
||||
% Methodology Box (Green) - For methods and procedures
|
||||
\newtcolorbox{methodology}[1][Methodology]{
|
||||
colback=lightgreen,
|
||||
colframe=sciencegreen,
|
||||
fonttitle=\bfseries\color{white},
|
||||
title=#1,
|
||||
coltitle=white,
|
||||
colbacktitle=sciencegreen,
|
||||
boxrule=1pt,
|
||||
arc=3pt,
|
||||
left=10pt,
|
||||
right=10pt,
|
||||
top=8pt,
|
||||
bottom=8pt,
|
||||
before skip=12pt,
|
||||
after skip=12pt,
|
||||
}
|
||||
|
||||
% Results Box (Blue-Green) - For highlighting key results
|
||||
\newtcolorbox{resultsbox}[1][Results Highlight]{
|
||||
colback=lightblue!50!lightgreen!50,
|
||||
colframe=darkgreen,
|
||||
fonttitle=\bfseries\color{white},
|
||||
title=#1,
|
||||
coltitle=white,
|
||||
colbacktitle=darkgreen,
|
||||
boxrule=1pt,
|
||||
arc=3pt,
|
||||
left=10pt,
|
||||
right=10pt,
|
||||
top=8pt,
|
||||
bottom=8pt,
|
||||
before skip=12pt,
|
||||
after skip=12pt,
|
||||
}
|
||||
|
||||
% Recommendations Box (Purple) - For recommendations and implications
|
||||
\newtcolorbox{recommendations}[1][Recommendations]{
|
||||
colback=lightpurple,
|
||||
colframe=recommendpurple,
|
||||
fonttitle=\bfseries\color{white},
|
||||
title=#1,
|
||||
coltitle=white,
|
||||
colbacktitle=recommendpurple,
|
||||
boxrule=1pt,
|
||||
arc=3pt,
|
||||
left=10pt,
|
||||
right=10pt,
|
||||
top=8pt,
|
||||
bottom=8pt,
|
||||
before skip=12pt,
|
||||
after skip=12pt,
|
||||
}
|
||||
|
||||
% Warning/Limitations Box (Orange) - For limitations, cautions, caveats
|
||||
\newtcolorbox{limitations}[1][Limitations]{
|
||||
colback=lightorange,
|
||||
colframe=cautionorange,
|
||||
fonttitle=\bfseries\color{white},
|
||||
title=#1,
|
||||
coltitle=white,
|
||||
colbacktitle=cautionorange,
|
||||
boxrule=1pt,
|
||||
arc=3pt,
|
||||
left=10pt,
|
||||
right=10pt,
|
||||
top=8pt,
|
||||
bottom=8pt,
|
||||
before skip=12pt,
|
||||
after skip=12pt,
|
||||
}
|
||||
|
||||
% Critical Notice Box (Red) - For critical warnings or important notices
|
||||
\newtcolorbox{criticalnotice}[1][Critical Notice]{
|
||||
colback=lightred,
|
||||
colframe=criticalred,
|
||||
fonttitle=\bfseries\color{white},
|
||||
title=#1,
|
||||
coltitle=white,
|
||||
colbacktitle=criticalred,
|
||||
boxrule=1pt,
|
||||
arc=3pt,
|
||||
left=10pt,
|
||||
right=10pt,
|
||||
top=8pt,
|
||||
bottom=8pt,
|
||||
before skip=12pt,
|
||||
after skip=12pt,
|
||||
}
|
||||
|
||||
% Definition Box (Gray) - For definitions, notes, supplementary info
|
||||
\newtcolorbox{definition}[1][Definition]{
|
||||
colback=lightgray,
|
||||
colframe=mediumgray,
|
||||
fonttitle=\bfseries\color{darkgray},
|
||||
title=#1,
|
||||
coltitle=darkgray,
|
||||
colbacktitle=lightgray,
|
||||
boxrule=0.5pt,
|
||||
arc=3pt,
|
||||
left=10pt,
|
||||
right=10pt,
|
||||
top=8pt,
|
||||
bottom=8pt,
|
||||
before skip=12pt,
|
||||
after skip=12pt,
|
||||
}
|
||||
|
||||
% Executive Summary Box (Special styling with shadow)
|
||||
\newtcolorbox{executivesummary}[1][Executive Summary]{
|
||||
enhanced,
|
||||
colback=white,
|
||||
colframe=primaryblue,
|
||||
fonttitle=\Large\bfseries\color{white},
|
||||
title=#1,
|
||||
coltitle=white,
|
||||
colbacktitle=primaryblue,
|
||||
boxrule=2pt,
|
||||
arc=5pt,
|
||||
left=15pt,
|
||||
right=15pt,
|
||||
top=12pt,
|
||||
bottom=12pt,
|
||||
before skip=15pt,
|
||||
after skip=15pt,
|
||||
shadow={2mm}{-2mm}{0mm}{black!20},
|
||||
}
|
||||
|
||||
% Hypothesis Box (Light blue with border) - For stating hypotheses
|
||||
\newtcolorbox{hypothesis}[1][Hypothesis]{
|
||||
enhanced,
|
||||
colback=lightblue!50,
|
||||
colframe=accentblue,
|
||||
fonttitle=\bfseries\color{white},
|
||||
title=#1,
|
||||
coltitle=white,
|
||||
colbacktitle=accentblue,
|
||||
boxrule=1pt,
|
||||
arc=3pt,
|
||||
left=10pt,
|
||||
right=10pt,
|
||||
top=8pt,
|
||||
bottom=8pt,
|
||||
before skip=12pt,
|
||||
after skip=12pt,
|
||||
}
|
||||
|
||||
% ============================================================================
|
||||
% PULL QUOTE ENVIRONMENT
|
||||
% ============================================================================
|
||||
|
||||
\newtcolorbox{pullquote}{
|
||||
enhanced,
|
||||
colback=lightgray,
|
||||
colframe=lightgray,
|
||||
boxrule=0pt,
|
||||
borderline west={4pt}{0pt}{primaryblue},
|
||||
arc=0pt,
|
||||
left=15pt,
|
||||
right=15pt,
|
||||
top=10pt,
|
||||
bottom=10pt,
|
||||
before skip=15pt,
|
||||
after skip=15pt,
|
||||
fontupper=\large\itshape\color{darkgray},
|
||||
}
|
||||
|
||||
% ============================================================================
|
||||
% STATISTIC HIGHLIGHT BOX
|
||||
% ============================================================================
|
||||
|
||||
\newcommand{\statbox}[2]{%
|
||||
\begin{tcolorbox}[
|
||||
colback=primaryblue,
|
||||
colframe=primaryblue,
|
||||
coltext=white,
|
||||
arc=5pt,
|
||||
boxrule=0pt,
|
||||
width=0.3\textwidth,
|
||||
halign=center,
|
||||
valign=center,
|
||||
before skip=10pt,
|
||||
after skip=10pt,
|
||||
]
|
||||
{\Huge\bfseries #1}\\[5pt]
|
||||
{\small #2}
|
||||
\end{tcolorbox}
|
||||
}
|
||||
|
||||
% ============================================================================
|
||||
% TABLE STYLING
|
||||
% ============================================================================
|
||||
|
||||
% Alternating row colors command
|
||||
\newcommand{\tablerowcolor}{\rowcolor{tablealt}}
|
||||
|
||||
% Table header styling
|
||||
\newcommand{\tableheader}[1]{\textbf{\color{white}#1}}
|
||||
\newcommand{\tableheaderrow}{\rowcolor{primaryblue}}
|
||||
|
||||
% Professional table environment
|
||||
\newenvironment{sciencetable}[2][htbp]{%
|
||||
\begin{table}[#1]
|
||||
\centering
|
||||
\caption{#2}
|
||||
\small
|
||||
}{%
|
||||
\end{table}
|
||||
}
|
||||
|
||||
% ============================================================================
|
||||
% FIGURE STYLING
|
||||
% ============================================================================
|
||||
|
||||
% Caption formatting
|
||||
\captionsetup{
|
||||
font=small,
|
||||
labelfont={bf,color=primaryblue},
|
||||
textfont={color=darkgray},
|
||||
justification=centering,
|
||||
margin=20pt,
|
||||
}
|
||||
|
||||
% Figure with source attribution
|
||||
\newcommand{\figuresource}[1]{%
|
||||
\par\vspace{-8pt}
|
||||
{\small\textit{Source: #1}}
|
||||
}
|
||||
|
||||
% Figure note
|
||||
\newcommand{\figurenote}[1]{%
|
||||
\par\vspace{-8pt}
|
||||
{\small\textit{Note: #1}}
|
||||
}
|
||||
|
||||
% ============================================================================
|
||||
% LIST STYLING
|
||||
% ============================================================================
|
||||
|
||||
% Bullet list styling with blue bullets
|
||||
\setlist[itemize]{
|
||||
leftmargin=*,
|
||||
label=\textcolor{primaryblue}{\textbullet},
|
||||
topsep=5pt,
|
||||
itemsep=3pt,
|
||||
}
|
||||
|
||||
% Numbered list styling with blue numbers
|
||||
\setlist[enumerate]{
|
||||
leftmargin=*,
|
||||
label=\textcolor{primaryblue}{\arabic*.},
|
||||
topsep=5pt,
|
||||
itemsep=3pt,
|
||||
}
|
||||
|
||||
% ============================================================================
|
||||
% SCIENTIFIC NOTATION COMMANDS
|
||||
% ============================================================================
|
||||
|
||||
% Highlight important text
|
||||
\newcommand{\highlight}[1]{\textbf{\textcolor{primaryblue}{#1}}}
|
||||
|
||||
% P-value formatting (with significance indicators)
|
||||
\newcommand{\pvalue}[1]{%
|
||||
\textit{p}~=~#1%
|
||||
}
|
||||
|
||||
% Significant p-value (bold)
|
||||
\newcommand{\psig}[1]{%
|
||||
\textbf{\textit{p}~=~#1}%
|
||||
}
|
||||
|
||||
% Confidence interval
|
||||
\newcommand{\CI}[2]{%
|
||||
95\% CI [#1, #2]%
|
||||
}
|
||||
|
||||
% Effect size formatting
|
||||
\newcommand{\effectsize}[2]{%
|
||||
#1~=~#2%
|
||||
}
|
||||
|
||||
% Sample size
|
||||
\newcommand{\samplesize}[1]{%
|
||||
\textit{n}~=~#1%
|
||||
}
|
||||
|
||||
% Mean with SD
|
||||
\newcommand{\meansd}[2]{%
|
||||
#1~$\pm$~#2%
|
||||
}
|
||||
|
||||
% Significance indicators
|
||||
\newcommand{\sigone}{\textsuperscript{*}} % p < 0.05
|
||||
\newcommand{\sigtwo}{\textsuperscript{**}} % p < 0.01
|
||||
\newcommand{\sigthree}{\textsuperscript{***}} % p < 0.001
|
||||
\newcommand{\signs}{\textsuperscript{ns}} % not significant
|
||||
|
||||
% Significance legend (for table footnotes)
|
||||
\newcommand{\siglegend}{%
|
||||
\textsuperscript{*}\textit{p}~<~0.05;
|
||||
\textsuperscript{**}\textit{p}~<~0.01;
|
||||
\textsuperscript{***}\textit{p}~<~0.001;
|
||||
\textsuperscript{ns}not significant%
|
||||
}
|
||||
|
||||
% ============================================================================
|
||||
% STATUS INDICATORS
|
||||
% ============================================================================
|
||||
|
||||
% Trend indicators
|
||||
\newcommand{\trendup}{\textcolor{darkgreen}{$\blacktriangle$}}
|
||||
\newcommand{\trenddown}{\textcolor{criticalred}{$\blacktriangledown$}}
|
||||
\newcommand{\trendflat}{\textcolor{mediumgray}{$\rightarrow$}}
|
||||
|
||||
% Quality/Rating indicators
|
||||
\newcommand{\qualityhigh}{\textbf{\textcolor{darkgreen}{HIGH}}}
|
||||
\newcommand{\qualitymedium}{\textbf{\textcolor{cautionorange}{MEDIUM}}}
|
||||
\newcommand{\qualitylow}{\textbf{\textcolor{criticalred}{LOW}}}
|
||||
|
||||
% Evidence strength
|
||||
\newcommand{\evidencestrong}{\textbf{\textcolor{darkgreen}{Strong}}}
|
||||
\newcommand{\evidencemoderate}{\textbf{\textcolor{cautionorange}{Moderate}}}
|
||||
\newcommand{\evidenceweak}{\textbf{\textcolor{criticalred}{Weak}}}
|
||||
|
||||
% ============================================================================
|
||||
% TITLE PAGE COMMAND
|
||||
% ============================================================================
|
||||
|
||||
\newcommand{\makereporttitle}[5]{%
|
||||
% #1 = Report Title
|
||||
% #2 = Subtitle
|
||||
% #3 = Author(s)
|
||||
% #4 = Institution/Organization
|
||||
% #5 = Date
|
||||
\begin{titlepage}
|
||||
\centering
|
||||
\vspace*{2cm}
|
||||
|
||||
{\Huge\bfseries\color{primaryblue} #1\\[0.5cm]}
|
||||
{\LARGE #2\\[2cm]}
|
||||
|
||||
\vspace{2cm}
|
||||
|
||||
{\Large\bfseries #3\\[0.5cm]}
|
||||
{\large #4\\[2cm]}
|
||||
|
||||
{\large\bfseries Date: #5\\[0.3cm]}
|
||||
|
||||
\vfill
|
||||
|
||||
\begin{tikzpicture}
|
||||
\fill[primaryblue] (0,0) rectangle (\textwidth,0.5);
|
||||
\end{tikzpicture}
|
||||
|
||||
\end{titlepage}
|
||||
}
|
||||
|
||||
% Alternative title page with image
|
||||
\newcommand{\makereporttitlewithimage}[6]{%
|
||||
% #1 = Report Title
|
||||
% #2 = Subtitle
|
||||
% #3 = Hero Image Path
|
||||
% #4 = Author(s)
|
||||
% #5 = Institution/Organization
|
||||
% #6 = Date
|
||||
\begin{titlepage}
|
||||
\centering
|
||||
\vspace*{1cm}
|
||||
|
||||
{\Huge\bfseries\color{primaryblue} #1\\[0.5cm]}
|
||||
{\LARGE #2\\[1.5cm]}
|
||||
|
||||
\ifx&
|
||||
\vspace{4cm}
|
||||
\else
|
||||
\includegraphics[width=0.8\textwidth]{#3}\\[1.5cm]
|
||||
\fi
|
||||
|
||||
{\Large\bfseries #4\\[0.5cm]}
|
||||
{\large #5\\[1.5cm]}
|
||||
|
||||
{\large\bfseries Date: #6}
|
||||
|
||||
\vfill
|
||||
|
||||
\begin{tikzpicture}
|
||||
\fill[primaryblue] (0,0) rectangle (\textwidth,0.5);
|
||||
\end{tikzpicture}
|
||||
|
||||
\end{titlepage}
|
||||
}
|
||||
|
||||
% ============================================================================
|
||||
% APPENDIX SECTION COMMAND
|
||||
% ============================================================================
|
||||
|
||||
\newcommand{\appendixsection}[1]{%
|
||||
\section*{#1}
|
||||
\addcontentsline{toc}{section}{#1}
|
||||
}
|
||||
|
||||
% ============================================================================
|
||||
% PAGE LAYOUT ADJUSTMENTS
|
||||
% ============================================================================
|
||||
|
||||
% Spacing
|
||||
\setstretch{1.15}
|
||||
\setlength{\parskip}{0.5em}
|
||||
|
||||
% Prevent orphans and widows
|
||||
\clubpenalty=10000
|
||||
\widowpenalty=10000
|
||||
|
||||
% Float placement
|
||||
\renewcommand{\topfraction}{0.9}
|
||||
\renewcommand{\bottomfraction}{0.8}
|
||||
\renewcommand{\textfraction}{0.07}
|
||||
\renewcommand{\floatpagefraction}{0.7}
|
||||
|
||||
% ============================================================================
|
||||
% END OF STYLE FILE
|
||||
% ============================================================================
|
||||
|
||||
\endinput
|
||||
|
||||
@@ -0,0 +1,449 @@
|
||||
% Scientific Report Template
|
||||
% Uses scientific_report.sty for professional formatting
|
||||
% Compile with: xelatex or lualatex
|
||||
%
|
||||
% This template demonstrates the full capabilities of the scientific_report.sty
|
||||
% style package for creating professional research reports, technical reports,
|
||||
% and white papers.
|
||||
|
||||
\documentclass[11pt,letterpaper]{report}
|
||||
|
||||
% Load the scientific report style package
|
||||
\usepackage{scientific_report}
|
||||
|
||||
% Additional packages (optional, add as needed)
|
||||
\usepackage{lipsum} % For placeholder text - remove in actual documents
|
||||
|
||||
% ============================================================================
|
||||
% DOCUMENT METADATA
|
||||
% ============================================================================
|
||||
|
||||
\hypersetup{
|
||||
pdftitle={Research Report Title},
|
||||
pdfauthor={Author Name},
|
||||
pdfsubject={Research Subject},
|
||||
pdfkeywords={keyword1, keyword2, keyword3}
|
||||
}
|
||||
|
||||
% ============================================================================
|
||||
% DOCUMENT BEGIN
|
||||
% ============================================================================
|
||||
|
||||
\begin{document}
|
||||
|
||||
% ----------------------------------------------------------------------------
|
||||
% TITLE PAGE
|
||||
% ----------------------------------------------------------------------------
|
||||
|
||||
\makereporttitle
|
||||
{Research Report Title} % Title
|
||||
{A Comprehensive Analysis of [Topic]} % Subtitle
|
||||
{Author Name, PhD} % Author(s)
|
||||
{Research Institution / Organization} % Institution
|
||||
{January 2025} % Date
|
||||
|
||||
% Alternative: Title page with cover image
|
||||
% \makereporttitlewithimage
|
||||
% {Research Report Title}
|
||||
% {A Comprehensive Analysis of [Topic]}
|
||||
% {../figures/cover_image.png}
|
||||
% {Author Name, PhD}
|
||||
% {Research Institution / Organization}
|
||||
% {January 2025}
|
||||
|
||||
% ----------------------------------------------------------------------------
|
||||
% FRONT MATTER
|
||||
% ----------------------------------------------------------------------------
|
||||
|
||||
\pagenumbering{roman}
|
||||
|
||||
% Table of Contents
|
||||
\tableofcontents
|
||||
\newpage
|
||||
|
||||
% List of Figures
|
||||
\listoffigures
|
||||
\newpage
|
||||
|
||||
% List of Tables
|
||||
\listoftables
|
||||
\newpage
|
||||
|
||||
% ----------------------------------------------------------------------------
|
||||
% EXECUTIVE SUMMARY
|
||||
% ----------------------------------------------------------------------------
|
||||
|
||||
\chapter*{Executive Summary}
|
||||
\addcontentsline{toc}{chapter}{Executive Summary}
|
||||
|
||||
\begin{executivesummary}[Report Overview]
|
||||
This report presents a comprehensive analysis of [topic]. Our investigation reveals significant findings that have implications for [field/application]. The research was conducted using [methodology] and involved [sample/data description].
|
||||
\end{executivesummary}
|
||||
|
||||
\subsection*{Key Findings}
|
||||
|
||||
\begin{keyfindings}
|
||||
\begin{enumerate}
|
||||
\item \textbf{Finding 1:} Description of the first major finding with supporting data (\pvalue{0.001}, \samplesize{250}).
|
||||
\item \textbf{Finding 2:} Description of the second major finding with effect size (\effectsize{d}{0.75}).
|
||||
\item \textbf{Finding 3:} Description of the third major finding (\meansd{42.5}{8.3}).
|
||||
\end{enumerate}
|
||||
\end{keyfindings}
|
||||
|
||||
\subsection*{Recommendations}
|
||||
|
||||
\begin{recommendations}
|
||||
\begin{enumerate}
|
||||
\item Implement [specific action] to address [issue].
|
||||
\item Allocate resources for [specific initiative].
|
||||
\item Conduct follow-up research on [topic].
|
||||
\end{enumerate}
|
||||
\end{recommendations}
|
||||
|
||||
\newpage
|
||||
\pagenumbering{arabic}
|
||||
|
||||
% ----------------------------------------------------------------------------
|
||||
% CHAPTER 1: INTRODUCTION
|
||||
% ----------------------------------------------------------------------------
|
||||
|
||||
\chapter{Introduction}
|
||||
|
||||
\section{Background}
|
||||
|
||||
This section provides context for the research. Include relevant background information, the current state of knowledge, and the rationale for the study.
|
||||
|
||||
\begin{definition}[Key Term]
|
||||
A \textbf{key term} is defined as [definition]. This concept is fundamental to understanding the research presented in this report.
|
||||
\end{definition}
|
||||
|
||||
\section{Research Objectives}
|
||||
|
||||
The primary objectives of this research are:
|
||||
|
||||
\begin{enumerate}
|
||||
\item To investigate [objective 1]
|
||||
\item To analyze [objective 2]
|
||||
\item To evaluate [objective 3]
|
||||
\end{enumerate}
|
||||
|
||||
\section{Hypotheses}
|
||||
|
||||
\begin{hypothesis}[Primary Hypothesis]
|
||||
We hypothesize that [independent variable] will have a significant effect on [dependent variable], such that [expected direction of effect].
|
||||
\end{hypothesis}
|
||||
|
||||
\section{Scope and Limitations}
|
||||
|
||||
\begin{limitations}[Study Scope]
|
||||
This research focuses on [specific scope]. The following limitations should be considered when interpreting the results:
|
||||
\begin{itemize}
|
||||
\item Geographic limitation: [description]
|
||||
\item Temporal limitation: [description]
|
||||
\item Sample limitation: [description]
|
||||
\end{itemize}
|
||||
\end{limitations}
|
||||
|
||||
% ----------------------------------------------------------------------------
|
||||
% CHAPTER 2: METHODOLOGY
|
||||
% ----------------------------------------------------------------------------
|
||||
|
||||
\chapter{Methodology}
|
||||
|
||||
\section{Study Design}
|
||||
|
||||
\begin{methodology}[Research Design Overview]
|
||||
This study employed a [type] design to investigate [research question]. The methodology was selected based on [rationale] and follows established guidelines for [type of research].
|
||||
\end{methodology}
|
||||
|
||||
\section{Participants}
|
||||
|
||||
A total of \samplesize{500} participants were recruited from [population]. Table~\ref{tab:demographics} presents the demographic characteristics of the sample.
|
||||
|
||||
\begin{table}[htbp]
|
||||
\centering
|
||||
\caption{Participant Demographics}
|
||||
\label{tab:demographics}
|
||||
\begin{tabular}{@{}lcc@{}}
|
||||
\toprule
|
||||
\tableheader{Characteristic} & \tableheader{n} & \tableheader{\%} \\
|
||||
\midrule
|
||||
\textbf{Gender} & & \\
|
||||
\quad Male & 245 & 49.0 \\
|
||||
\rowcolor{tablealt} \quad Female & 255 & 51.0 \\
|
||||
\textbf{Age Group} & & \\
|
||||
\quad 18--30 & 150 & 30.0 \\
|
||||
\rowcolor{tablealt} \quad 31--45 & 200 & 40.0 \\
|
||||
\quad 46--60 & 120 & 24.0 \\
|
||||
\rowcolor{tablealt} \quad 60+ & 30 & 6.0 \\
|
||||
\bottomrule
|
||||
\end{tabular}
|
||||
\end{table}
|
||||
|
||||
\section{Instruments}
|
||||
|
||||
\subsection{Primary Measures}
|
||||
|
||||
The following instruments were used to collect data:
|
||||
|
||||
\begin{itemize}
|
||||
\item \textbf{Instrument 1:} Description and psychometric properties
|
||||
\item \textbf{Instrument 2:} Description and psychometric properties
|
||||
\item \textbf{Instrument 3:} Description and psychometric properties
|
||||
\end{itemize}
|
||||
|
||||
\section{Procedures}
|
||||
|
||||
Data collection occurred between [dates]. The procedure involved the following steps:
|
||||
|
||||
\begin{enumerate}
|
||||
\item Informed consent was obtained from all participants.
|
||||
\item Baseline assessments were administered.
|
||||
\item Intervention/treatment was delivered (if applicable).
|
||||
\item Follow-up assessments were conducted at [timepoints].
|
||||
\end{enumerate}
|
||||
|
||||
\section{Statistical Analysis}
|
||||
|
||||
Data were analyzed using [software] version [X.X]. The following analyses were performed:
|
||||
|
||||
\begin{itemize}
|
||||
\item Descriptive statistics for all variables
|
||||
\item [Analysis type] to test hypothesis 1
|
||||
\item [Analysis type] to test hypothesis 2
|
||||
\end{itemize}
|
||||
|
||||
Statistical significance was set at $\alpha = 0.05$. Effect sizes were calculated using [method] and interpreted according to [guidelines].
|
||||
|
||||
% ----------------------------------------------------------------------------
|
||||
% CHAPTER 3: RESULTS
|
||||
% ----------------------------------------------------------------------------
|
||||
|
||||
\chapter{Results}
|
||||
|
||||
\section{Descriptive Statistics}
|
||||
|
||||
Table~\ref{tab:descriptives} presents the descriptive statistics for the primary outcome measures.
|
||||
|
||||
\begin{table}[htbp]
|
||||
\centering
|
||||
\caption{Descriptive Statistics for Primary Outcome Measures}
|
||||
\label{tab:descriptives}
|
||||
\begin{tabular}{@{}lccccc@{}}
|
||||
\toprule
|
||||
\tableheader{Variable} & \tableheader{n} & \tableheader{Mean} & \tableheader{SD} & \tableheader{Min} & \tableheader{Max} \\
|
||||
\midrule
|
||||
Outcome 1 & 500 & 42.5 & 8.3 & 18 & 72 \\
|
||||
\rowcolor{tablealt} Outcome 2 & 498 & 3.7 & 1.2 & 1 & 7 \\
|
||||
Outcome 3 & 495 & 128.4 & 24.7 & 68 & 195 \\
|
||||
\rowcolor{tablealt} Outcome 4 & 500 & 0.68 & 0.15 & 0.28 & 0.95 \\
|
||||
\bottomrule
|
||||
\end{tabular}
|
||||
\figurenote{SD = Standard Deviation}
|
||||
\end{table}
|
||||
|
||||
\section{Primary Analyses}
|
||||
|
||||
\subsection{Hypothesis 1}
|
||||
|
||||
\begin{resultsbox}[Primary Finding]
|
||||
Analysis revealed a significant effect of [IV] on [DV], \effectsize{F(2, 497)}{12.45}, \psig{< 0.001}, $\eta^2$ = 0.048. Post-hoc comparisons indicated that [specific findings].
|
||||
\end{resultsbox}
|
||||
|
||||
The results support our primary hypothesis. As shown in Figure~\ref{fig:main_results}, participants in the experimental condition demonstrated significantly higher scores compared to the control group.
|
||||
|
||||
% Placeholder for figure
|
||||
\begin{figure}[htbp]
|
||||
\centering
|
||||
\fbox{\parbox{0.8\textwidth}{\centering\vspace{3cm}[Figure: Main Results Comparison]\\Bar chart showing group differences\vspace{3cm}}}
|
||||
\caption{Comparison of Outcome Scores by Experimental Condition}
|
||||
\label{fig:main_results}
|
||||
\figuresource{Study data}
|
||||
\end{figure}
|
||||
|
||||
\subsection{Hypothesis 2}
|
||||
|
||||
Results indicated a moderate positive correlation between [variable 1] and [variable 2], \effectsize{r}{0.45}, \psig{< 0.001}, \CI{0.38}{0.52}.
|
||||
|
||||
\section{Secondary Analyses}
|
||||
|
||||
Table~\ref{tab:regression} presents the results of the regression analysis predicting [outcome].
|
||||
|
||||
\begin{table}[htbp]
|
||||
\centering
|
||||
\caption{Multiple Regression Analysis Predicting Outcome}
|
||||
\label{tab:regression}
|
||||
\begin{tabular}{@{}lcccc@{}}
|
||||
\toprule
|
||||
\tableheader{Predictor} & \tableheader{B} & \tableheader{SE} & \tableheader{$\beta$} & \tableheader{p} \\
|
||||
\midrule
|
||||
(Intercept) & 12.45 & 2.34 & --- & < .001 \\
|
||||
\rowcolor{tablealt} Predictor 1 & 0.58 & 0.12 & 0.28\sigthree & < .001 \\
|
||||
Predictor 2 & 0.34 & 0.09 & 0.22\sigtwo & .002 \\
|
||||
\rowcolor{tablealt} Predictor 3 & 0.15 & 0.11 & 0.08\signs & .172 \\
|
||||
Predictor 4 & -0.42 & 0.14 & -0.18\sigtwo & .003 \\
|
||||
\midrule
|
||||
\multicolumn{5}{l}{$R^2$ = 0.34, Adjusted $R^2$ = 0.33, \effectsize{F(4, 495)}{63.82}\sigthree} \\
|
||||
\bottomrule
|
||||
\end{tabular}
|
||||
|
||||
\vspace{0.5em}
|
||||
{\small \siglegend}
|
||||
\end{table}
|
||||
|
||||
% ----------------------------------------------------------------------------
|
||||
% CHAPTER 4: DISCUSSION
|
||||
% ----------------------------------------------------------------------------
|
||||
|
||||
\chapter{Discussion}
|
||||
|
||||
\section{Summary of Findings}
|
||||
|
||||
\begin{keyfindings}[Key Takeaways]
|
||||
\begin{enumerate}
|
||||
\item The primary hypothesis was \highlight{supported}, with significant effects observed for [variables].
|
||||
\item Evidence quality for the main findings is \evidencestrong, based on effect sizes and replication potential.
|
||||
\item Unexpected finding: [description of any surprising results].
|
||||
\end{enumerate}
|
||||
\end{keyfindings}
|
||||
|
||||
\section{Interpretation}
|
||||
|
||||
The findings from this study contribute to our understanding of [topic] in several important ways. First, the significant effect of [IV] on [DV] suggests that [interpretation]. This aligns with previous research by [Author] (Year), who found similar patterns in [context].
|
||||
|
||||
\begin{pullquote}
|
||||
``These findings represent a significant advancement in our understanding of [topic] and have direct implications for [application/practice].''
|
||||
\end{pullquote}
|
||||
|
||||
Second, the correlation between [variables] indicates that [interpretation]. This relationship has important implications for [field/practice].
|
||||
|
||||
\section{Implications}
|
||||
|
||||
\subsection{Theoretical Implications}
|
||||
|
||||
The results have several theoretical implications:
|
||||
|
||||
\begin{itemize}
|
||||
\item Support for [theory/model]
|
||||
\item Extension of [existing framework]
|
||||
\item Challenge to [alternative perspective]
|
||||
\end{itemize}
|
||||
|
||||
\subsection{Practical Implications}
|
||||
|
||||
\begin{recommendations}[Practical Applications]
|
||||
Based on our findings, we recommend the following practical applications:
|
||||
\begin{enumerate}
|
||||
\item \textbf{For practitioners:} [specific recommendation]
|
||||
\item \textbf{For policymakers:} [specific recommendation]
|
||||
\item \textbf{For researchers:} [specific recommendation]
|
||||
\end{enumerate}
|
||||
\end{recommendations}
|
||||
|
||||
\section{Limitations}
|
||||
|
||||
\begin{limitations}[Study Limitations]
|
||||
Several limitations should be considered when interpreting these findings:
|
||||
\begin{itemize}
|
||||
\item \textbf{Sample:} The sample was drawn from [population], which may limit generalizability to [other populations].
|
||||
\item \textbf{Design:} The [cross-sectional/correlational] design precludes causal inference.
|
||||
\item \textbf{Measurement:} Self-report measures may be subject to [bias type].
|
||||
\end{itemize}
|
||||
\end{limitations}
|
||||
|
||||
\section{Future Directions}
|
||||
|
||||
Future research should address the following questions:
|
||||
|
||||
\begin{enumerate}
|
||||
\item Does the effect generalize to [different population/context]?
|
||||
\item What mechanisms underlie the relationship between [variables]?
|
||||
\item How do [moderating factors] influence the observed effects?
|
||||
\end{enumerate}
|
||||
|
||||
% ----------------------------------------------------------------------------
|
||||
% CHAPTER 5: CONCLUSIONS
|
||||
% ----------------------------------------------------------------------------
|
||||
|
||||
\chapter{Conclusions}
|
||||
|
||||
\begin{executivesummary}[Conclusion]
|
||||
This research investigated [topic] using [methodology] with a sample of \samplesize{500} participants. The findings demonstrate that [main conclusion]. These results have important implications for [field/practice] and suggest that [recommendation]. Future research should continue to explore [direction].
|
||||
\end{executivesummary}
|
||||
|
||||
\section{Key Contributions}
|
||||
|
||||
\begin{keyfindings}[Research Contributions]
|
||||
This study makes the following key contributions:
|
||||
\begin{enumerate}
|
||||
\item \textbf{Empirical contribution:} First demonstration of [finding] in [context].
|
||||
\item \textbf{Methodological contribution:} Novel application of [method] to study [phenomenon].
|
||||
\item \textbf{Practical contribution:} Evidence-based recommendations for [application].
|
||||
\end{enumerate}
|
||||
\end{keyfindings}
|
||||
|
||||
% ----------------------------------------------------------------------------
|
||||
% REFERENCES
|
||||
% ----------------------------------------------------------------------------
|
||||
|
||||
\chapter*{References}
|
||||
\addcontentsline{toc}{chapter}{References}
|
||||
|
||||
% If using BibTeX:
|
||||
% \bibliographystyle{apalike}
|
||||
% \bibliography{references}
|
||||
|
||||
% Manual references for template demonstration:
|
||||
\noindent
|
||||
\hangindent=0.5in Author, A. A. (Year). Title of article. \textit{Journal Name}, \textit{Volume}(Issue), pages. https://doi.org/xxxxx
|
||||
|
||||
\vspace{0.5em}
|
||||
\noindent
|
||||
\hangindent=0.5in Author, B. B., \& Author, C. C. (Year). \textit{Title of book}. Publisher.
|
||||
|
||||
% ----------------------------------------------------------------------------
|
||||
% APPENDICES
|
||||
% ----------------------------------------------------------------------------
|
||||
|
||||
\appendix
|
||||
|
||||
\chapter{Supplementary Materials}
|
||||
|
||||
\appendixsection{Additional Tables}
|
||||
|
||||
Table~\ref{tab:appendix1} presents additional descriptive statistics not included in the main text.
|
||||
|
||||
\begin{table}[htbp]
|
||||
\centering
|
||||
\caption{Supplementary Descriptive Statistics}
|
||||
\label{tab:appendix1}
|
||||
\begin{tabular}{@{}lccc@{}}
|
||||
\toprule
|
||||
\tableheader{Variable} & \tableheader{Mean} & \tableheader{SD} & \tableheader{n} \\
|
||||
\midrule
|
||||
Variable A & 15.2 & 3.4 & 500 \\
|
||||
\rowcolor{tablealt} Variable B & 22.8 & 5.1 & 498 \\
|
||||
Variable C & 8.9 & 2.2 & 495 \\
|
||||
\bottomrule
|
||||
\end{tabular}
|
||||
\end{table}
|
||||
|
||||
\appendixsection{Instruments}
|
||||
|
||||
Full text of instruments used in this study:
|
||||
|
||||
\begin{enumerate}
|
||||
\item \textbf{Instrument Name 1:} [Description or full text]
|
||||
\item \textbf{Instrument Name 2:} [Description or full text]
|
||||
\end{enumerate}
|
||||
|
||||
\appendixsection{Additional Figures}
|
||||
|
||||
[Include any supplementary figures here]
|
||||
|
||||
% ============================================================================
|
||||
% END DOCUMENT
|
||||
% ============================================================================
|
||||
|
||||
\end{document}
|
||||
|
||||
@@ -0,0 +1,664 @@
|
||||
# Professional Report Formatting for Scientific Documents
|
||||
|
||||
This reference guide covers professional formatting for scientific reports, technical documents, and white papers. Use the `scientific_report.sty` LaTeX style package for consistent, professional output.
|
||||
|
||||
---
|
||||
|
||||
## When to Use Professional Report Formatting
|
||||
|
||||
### Use This Style For:
|
||||
|
||||
- **Research reports** - Internal and external research summaries
|
||||
- **Technical reports** - Detailed technical documentation and analyses
|
||||
- **White papers** - Position papers and thought leadership documents
|
||||
- **Grant reports** - Progress reports and final grant reports
|
||||
- **Policy briefs** - Research-informed policy recommendations
|
||||
- **Industry reports** - Technical reports for industry audiences
|
||||
- **Internal research summaries** - Team and stakeholder communications
|
||||
- **Feasibility studies** - Technical and research feasibility assessments
|
||||
- **Project documentation** - Research project deliverables
|
||||
|
||||
### Do NOT Use This Style For:
|
||||
|
||||
- **Journal manuscripts** → Use `venue-templates` skill for journal-specific formatting
|
||||
- **Conference papers** → Use `venue-templates` skill for conference requirements
|
||||
- **Academic theses/dissertations** → Use institutional templates
|
||||
- **Peer-reviewed submissions** → Follow journal author guidelines
|
||||
|
||||
**Key Distinction**: Professional report formatting prioritizes visual appeal and readability for general audiences, while journal manuscripts must follow strict publisher requirements.
|
||||
|
||||
---
|
||||
|
||||
## Overview of scientific_report.sty
|
||||
|
||||
The `scientific_report.sty` package provides:
|
||||
|
||||
| Feature | Description |
|
||||
|---------|-------------|
|
||||
| Typography | Helvetica font family for modern, professional appearance |
|
||||
| Color Scheme | Coordinated blues, greens, oranges, and purples |
|
||||
| Box Environments | Colored boxes for organizing content types |
|
||||
| Tables | Professional styling with alternating rows |
|
||||
| Figures | Consistent caption formatting |
|
||||
| Headers/Footers | Professional page headers and footers |
|
||||
| Scientific Commands | Shortcuts for p-values, effect sizes, statistics |
|
||||
|
||||
### Basic Document Setup
|
||||
|
||||
```latex
|
||||
\documentclass[11pt,letterpaper]{report}
|
||||
\usepackage{scientific_report}
|
||||
|
||||
\begin{document}
|
||||
% Your content here
|
||||
\end{document}
|
||||
```
|
||||
|
||||
**Compilation**: Use XeLaTeX or LuaLaTeX for proper Helvetica font rendering:
|
||||
```bash
|
||||
xelatex document.tex
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Box Environments for Content Organization
|
||||
|
||||
### Purpose and Usage
|
||||
|
||||
Colored boxes help readers quickly identify different types of content. Use them strategically to highlight important information.
|
||||
|
||||
### Available Box Environments
|
||||
|
||||
| Environment | Color | Purpose |
|
||||
|-------------|-------|---------|
|
||||
| `keyfindings` | Blue | Major findings, discoveries, key takeaways |
|
||||
| `methodology` | Green | Methods, procedures, study design |
|
||||
| `resultsbox` | Blue-green | Statistical results, data highlights |
|
||||
| `recommendations` | Purple | Recommendations, action items, implications |
|
||||
| `limitations` | Orange | Limitations, cautions, caveats |
|
||||
| `criticalnotice` | Red | Critical warnings, safety notices |
|
||||
| `definition` | Gray | Definitions, notes, supplementary info |
|
||||
| `executivesummary` | Blue (shadow) | Executive summaries |
|
||||
| `hypothesis` | Light blue | Research hypotheses |
|
||||
|
||||
### Key Findings Box
|
||||
|
||||
Use for major findings and important discoveries:
|
||||
|
||||
```latex
|
||||
\begin{keyfindings}[Research Highlights]
|
||||
Our analysis revealed three significant findings:
|
||||
\begin{enumerate}
|
||||
\item Treatment A was 40% more effective than control (\pvalue{0.001})
|
||||
\item Effect sizes were clinically meaningful (\effectsize{d}{0.82})
|
||||
\item Benefits persisted at 12-month follow-up
|
||||
\end{enumerate}
|
||||
\end{keyfindings}
|
||||
```
|
||||
|
||||
**Best Practices:**
|
||||
- Use sparingly (1-3 per chapter maximum)
|
||||
- Reserve for genuinely important findings
|
||||
- Include specific numbers and statistics
|
||||
- Write concisely
|
||||
|
||||
### Methodology Box
|
||||
|
||||
Use for highlighting methods and procedures:
|
||||
|
||||
```latex
|
||||
\begin{methodology}[Study Design]
|
||||
This double-blind, randomized controlled trial employed a 2×2 factorial
|
||||
design. Participants (\samplesize{450}) were randomized to one of four
|
||||
conditions: (1) Treatment A, (2) Treatment B, (3) Combined A+B, or
|
||||
(4) Placebo control.
|
||||
\end{methodology}
|
||||
```
|
||||
|
||||
**Best Practices:**
|
||||
- Summarize key methodological features
|
||||
- Use at the start of methods sections
|
||||
- Include sample size and design type
|
||||
- Keep technical but accessible
|
||||
|
||||
### Results Box
|
||||
|
||||
Use for highlighting specific statistical results:
|
||||
|
||||
```latex
|
||||
\begin{resultsbox}[Primary Outcome Analysis]
|
||||
Mixed-effects regression revealed a significant treatment × time
|
||||
interaction, \effectsize{F(3, 446)}{8.72}, \psig{< 0.001},
|
||||
$\eta^2_p$ = 0.055, indicating differential improvement across
|
||||
treatment conditions over the study period.
|
||||
\end{resultsbox}
|
||||
```
|
||||
|
||||
**Best Practices:**
|
||||
- Report complete statistical information
|
||||
- Use scientific notation commands
|
||||
- Include effect sizes alongside p-values
|
||||
- One box per major analysis
|
||||
|
||||
### Recommendations Box
|
||||
|
||||
Use for recommendations and implications:
|
||||
|
||||
```latex
|
||||
\begin{recommendations}[Clinical Practice Guidelines]
|
||||
Based on our findings, we recommend:
|
||||
\begin{enumerate}
|
||||
\item \textbf{Primary recommendation:} Implement screening protocol
|
||||
for high-risk populations.
|
||||
\item \textbf{Secondary recommendation:} Adjust treatment intensity
|
||||
based on baseline severity scores.
|
||||
\item \textbf{Monitoring:} Reassess at 3-month intervals.
|
||||
\end{enumerate}
|
||||
\end{recommendations}
|
||||
```
|
||||
|
||||
**Best Practices:**
|
||||
- Make recommendations specific and actionable
|
||||
- Prioritize with clear labels
|
||||
- Link to supporting evidence
|
||||
- Include implementation guidance
|
||||
|
||||
### Limitations Box
|
||||
|
||||
Use for limitations, caveats, and cautions:
|
||||
|
||||
```latex
|
||||
\begin{limitations}[Study Limitations]
|
||||
Several limitations should be considered:
|
||||
\begin{itemize}
|
||||
\item \textbf{Sample:} Participants were recruited from academic
|
||||
medical centers, limiting generalizability to community settings.
|
||||
\item \textbf{Design:} The observational design precludes causal
|
||||
inference about treatment effects.
|
||||
\item \textbf{Attrition:} 15% dropout rate may introduce bias.
|
||||
\end{itemize}
|
||||
\end{limitations}
|
||||
```
|
||||
|
||||
**Best Practices:**
|
||||
- Be honest and thorough
|
||||
- Explain implications of each limitation
|
||||
- Suggest how future research could address limitations
|
||||
- Don't over-qualify findings
|
||||
|
||||
### Critical Notice Box
|
||||
|
||||
Use for critical warnings or safety information:
|
||||
|
||||
```latex
|
||||
\begin{criticalnotice}[Safety Warning]
|
||||
\textbf{Contraindication:} This intervention is contraindicated for
|
||||
patients with [condition]. Monitor for [adverse effects] and discontinue
|
||||
immediately if [symptoms] occur. Report serious adverse events to [contact].
|
||||
\end{criticalnotice}
|
||||
```
|
||||
|
||||
**Best Practices:**
|
||||
- Reserve for genuinely critical information
|
||||
- Be clear and direct
|
||||
- Include specific actions to take
|
||||
- Provide contact information if relevant
|
||||
|
||||
### Definition Box
|
||||
|
||||
Use for definitions and explanatory notes:
|
||||
|
||||
```latex
|
||||
\begin{definition}[Effect Size]
|
||||
An \textbf{effect size} is a quantitative measure of the magnitude of a
|
||||
phenomenon. Unlike significance tests, effect sizes are independent of
|
||||
sample size and allow comparison across studies. Common measures include
|
||||
Cohen's \textit{d} for mean differences and Pearson's \textit{r} for
|
||||
correlations.
|
||||
\end{definition}
|
||||
```
|
||||
|
||||
**Best Practices:**
|
||||
- Define technical terms at first use
|
||||
- Keep definitions concise
|
||||
- Include practical interpretation guidance
|
||||
- Use for audience-appropriate terms
|
||||
|
||||
---
|
||||
|
||||
## Professional Table Formatting
|
||||
|
||||
### Design Principles
|
||||
|
||||
1. **Clean appearance**: Use `booktabs` rules (`\toprule`, `\midrule`, `\bottomrule`)
|
||||
2. **Alternating rows**: Apply `\rowcolor{tablealt}` to every other row
|
||||
3. **Clear headers**: Bold headers for column identification
|
||||
4. **Appropriate precision**: Report statistics to appropriate decimal places
|
||||
5. **Complete information**: Include sample sizes, units, and notes
|
||||
|
||||
### Standard Data Table
|
||||
|
||||
```latex
|
||||
\begin{table}[htbp]
|
||||
\centering
|
||||
\caption{Demographic Characteristics by Treatment Group}
|
||||
\label{tab:demographics}
|
||||
\begin{tabular}{@{}lcc@{}}
|
||||
\toprule
|
||||
\textbf{Characteristic} & \textbf{Treatment} & \textbf{Control} \\
|
||||
& (\samplesize{225}) & (\samplesize{225}) \\
|
||||
\midrule
|
||||
Age, years, \meansd{M}{SD} & \meansd{42.3}{12.5} & \meansd{43.1}{11.8} \\
|
||||
\rowcolor{tablealt} Female, n (\%) & 128 (56.9) & 121 (53.8) \\
|
||||
Education, years, \meansd{M}{SD} & \meansd{14.2}{2.8} & \meansd{14.5}{2.6} \\
|
||||
\rowcolor{tablealt} Baseline score, \meansd{M}{SD} & \meansd{52.4}{15.3} & \meansd{51.8}{14.9} \\
|
||||
\bottomrule
|
||||
\end{tabular}
|
||||
\figurenote{No significant differences between groups at baseline (all \textit{p} > .10).}
|
||||
\end{table}
|
||||
```
|
||||
|
||||
### Results Table with Significance Indicators
|
||||
|
||||
```latex
|
||||
\begin{table}[htbp]
|
||||
\centering
|
||||
\caption{Treatment Effects on Primary and Secondary Outcomes}
|
||||
\label{tab:results}
|
||||
\begin{tabular}{@{}lcccc@{}}
|
||||
\toprule
|
||||
\textbf{Outcome} & \textbf{Treatment} & \textbf{Control} & \textbf{Effect} & \textbf{p} \\
|
||||
& \meansd{M}{SD} & \meansd{M}{SD} & \textbf{(d)} & \\
|
||||
\midrule
|
||||
Primary outcome & \meansd{68.4}{14.2} & \meansd{54.1}{15.8} & 0.95\sigthree & <.001 \\
|
||||
\rowcolor{tablealt} Secondary A & \meansd{4.2}{1.1} & \meansd{3.5}{1.2} & 0.61\sigtwo & .003 \\
|
||||
Secondary B & \meansd{22.8}{5.4} & \meansd{21.2}{5.1} & 0.31\sigone & .042 \\
|
||||
\rowcolor{tablealt} Secondary C & \meansd{8.9}{2.3} & \meansd{8.5}{2.4} & 0.17\signs & .285 \\
|
||||
\bottomrule
|
||||
\end{tabular}
|
||||
|
||||
\vspace{0.5em}
|
||||
{\small \siglegend}
|
||||
\end{table}
|
||||
```
|
||||
|
||||
### Comparison Table with Quality Ratings
|
||||
|
||||
```latex
|
||||
\begin{table}[htbp]
|
||||
\centering
|
||||
\caption{Evidence Summary by Study}
|
||||
\label{tab:evidence}
|
||||
\begin{tabular}{@{}llccc@{}}
|
||||
\toprule
|
||||
\textbf{Study} & \textbf{Design} & \textbf{N} & \textbf{Quality} & \textbf{Evidence} \\
|
||||
\midrule
|
||||
Smith et al. (2024) & RCT & 450 & \qualityhigh & \evidencestrong \\
|
||||
\rowcolor{tablealt} Jones et al. (2023) & Cohort & 1,250 & \qualitymedium & \evidencemoderate \\
|
||||
Chen et al. (2023) & Case-control & 320 & \qualitymedium & \evidencemoderate \\
|
||||
\rowcolor{tablealt} Lee et al. (2022) & Cross-sectional & 890 & \qualitylow & \evidenceweak \\
|
||||
\bottomrule
|
||||
\end{tabular}
|
||||
\end{table}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Figure and Caption Styling
|
||||
|
||||
### Caption Formatting
|
||||
|
||||
The style package automatically formats captions with:
|
||||
- Blue, bold figure labels
|
||||
- Gray descriptive text
|
||||
- Centered alignment with margins
|
||||
|
||||
### Standard Figure
|
||||
|
||||
```latex
|
||||
\begin{figure}[htbp]
|
||||
\centering
|
||||
\includegraphics[width=0.9\textwidth]{../figures/results_comparison.png}
|
||||
\caption{Comparison of Outcome Scores by Treatment Condition and Time Point}
|
||||
\label{fig:results}
|
||||
\end{figure}
|
||||
```
|
||||
|
||||
### Figure with Source Attribution
|
||||
|
||||
```latex
|
||||
\begin{figure}[htbp]
|
||||
\centering
|
||||
\includegraphics[width=0.85\textwidth]{../figures/trend_analysis.png}
|
||||
\caption{Trends in Key Metrics Over the Study Period}
|
||||
\figuresource{Study data collected January--December 2024}
|
||||
\label{fig:trends}
|
||||
\end{figure}
|
||||
```
|
||||
|
||||
### Figure with Explanatory Note
|
||||
|
||||
```latex
|
||||
\begin{figure}[htbp]
|
||||
\centering
|
||||
\includegraphics[width=0.8\textwidth]{../figures/conceptual_model.png}
|
||||
\caption{Conceptual Model of Hypothesized Relationships}
|
||||
\figurenote{Solid arrows indicate primary pathways; dashed arrows indicate moderated relationships. Numbers represent standardized coefficients.}
|
||||
\label{fig:model}
|
||||
\end{figure}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Color Palette and Visual Hierarchy
|
||||
|
||||
### Color Usage Guidelines
|
||||
|
||||
| Color | Use For | Avoid Using For |
|
||||
|-------|---------|-----------------|
|
||||
| Primary Blue | Headers, important findings | Warnings, cautions |
|
||||
| Science Green | Methods, positive results | Negative findings |
|
||||
| Orange | Cautions, limitations | Positive findings |
|
||||
| Red | Critical warnings | Routine content |
|
||||
| Purple | Recommendations | Findings, methods |
|
||||
| Gray | Definitions, notes | Key findings |
|
||||
|
||||
### Visual Hierarchy
|
||||
|
||||
1. **Executive summary boxes** (shadow effect) - Most prominent
|
||||
2. **Colored content boxes** - High prominence for key content
|
||||
3. **Tables with color** - Medium prominence for data
|
||||
4. **Body text** - Standard prominence
|
||||
5. **Definition boxes** - Lower prominence for supplementary info
|
||||
|
||||
### Accessibility Considerations
|
||||
|
||||
- Color palette is designed to be distinguishable for common color vision deficiencies
|
||||
- All boxes have both color AND structural indicators (borders, backgrounds)
|
||||
- Text maintains sufficient contrast ratios
|
||||
- Don't rely solely on color to convey meaning
|
||||
|
||||
---
|
||||
|
||||
## Typography Guidelines
|
||||
|
||||
### Font Specifications
|
||||
|
||||
| Element | Font | Size | Color |
|
||||
|---------|------|------|-------|
|
||||
| Body text | Helvetica | 11pt | Dark gray (#424242) |
|
||||
| Chapter titles | Helvetica Bold | Huge | Primary blue (#003366) |
|
||||
| Section headings | Helvetica Bold | Large | Primary blue (#003366) |
|
||||
| Subsections | Helvetica Bold | large | Secondary blue (#4A90E2) |
|
||||
| Subsubsections | Helvetica Bold | normalsize | Dark gray (#424242) |
|
||||
|
||||
### Spacing
|
||||
|
||||
- Line spacing: 1.15 (for readability)
|
||||
- Paragraph spacing: 0.5em between paragraphs
|
||||
- Page margins: 1 inch on all sides
|
||||
|
||||
### Best Typography Practices
|
||||
|
||||
1. **Consistency**: Use the same formatting for similar elements
|
||||
2. **Hierarchy**: Use visual weight to indicate importance
|
||||
3. **Readability**: Adequate spacing and contrast
|
||||
4. **Professionalism**: Avoid mixing fonts or excessive formatting
|
||||
|
||||
---
|
||||
|
||||
## Scientific Notation Commands Reference
|
||||
|
||||
### Statistical Reporting
|
||||
|
||||
| Command | Output | When to Use |
|
||||
|---------|--------|-------------|
|
||||
| `\pvalue{0.023}` | *p* = 0.023 | Report p-values |
|
||||
| `\psig{< 0.001}` | ***p*** = < 0.001 | Significant p-values (bold) |
|
||||
| `\CI{0.45}{0.72}` | 95% CI [0.45, 0.72] | Confidence intervals |
|
||||
| `\effectsize{d}{0.75}` | d = 0.75 | Effect sizes |
|
||||
| `\samplesize{250}` | *n* = 250 | Sample sizes |
|
||||
| `\meansd{42.5}{8.3}` | 42.5 ± 8.3 | Mean with SD |
|
||||
|
||||
### Significance Indicators
|
||||
|
||||
| Command | Output | Meaning |
|
||||
|---------|--------|---------|
|
||||
| `\sigone` | * | p < 0.05 |
|
||||
| `\sigtwo` | ** | p < 0.01 |
|
||||
| `\sigthree` | *** | p < 0.001 |
|
||||
| `\signs` | ns | not significant |
|
||||
| `\siglegend` | Full legend | For table footnotes |
|
||||
|
||||
### Quality and Evidence Ratings
|
||||
|
||||
| Command | Output | Meaning |
|
||||
|---------|--------|---------|
|
||||
| `\qualityhigh` | **HIGH** (green) | High quality |
|
||||
| `\qualitymedium` | **MEDIUM** (orange) | Moderate quality |
|
||||
| `\qualitylow` | **LOW** (red) | Low quality |
|
||||
| `\evidencestrong` | **Strong** (green) | Strong evidence |
|
||||
| `\evidencemoderate` | **Moderate** (orange) | Moderate evidence |
|
||||
| `\evidenceweak` | **Weak** (red) | Weak evidence |
|
||||
|
||||
### Trend Indicators
|
||||
|
||||
| Command | Symbol | Meaning |
|
||||
|---------|--------|---------|
|
||||
| `\trendup` | ▲ (green) | Increasing trend |
|
||||
| `\trenddown` | ▼ (red) | Decreasing trend |
|
||||
| `\trendflat` | → (gray) | Stable/no change |
|
||||
|
||||
---
|
||||
|
||||
## Complete LaTeX Examples
|
||||
|
||||
### Executive Summary Example
|
||||
|
||||
```latex
|
||||
\chapter*{Executive Summary}
|
||||
\addcontentsline{toc}{chapter}{Executive Summary}
|
||||
|
||||
\begin{executivesummary}[Report Highlights]
|
||||
This report presents findings from a comprehensive study of [topic]
|
||||
involving \samplesize{450} participants across 12 research sites.
|
||||
The research addressed [key question] using [methodology].
|
||||
\end{executivesummary}
|
||||
|
||||
\subsection*{Key Findings}
|
||||
|
||||
\begin{keyfindings}
|
||||
\begin{enumerate}
|
||||
\item The primary intervention demonstrated a large effect
|
||||
(\effectsize{d}{0.82}, \psig{< 0.001}).
|
||||
\item Benefits were maintained at 12-month follow-up.
|
||||
\item Cost-effectiveness analysis supports implementation.
|
||||
\end{enumerate}
|
||||
\end{keyfindings}
|
||||
|
||||
\subsection*{Recommendations}
|
||||
|
||||
\begin{recommendations}
|
||||
Based on these findings, we recommend:
|
||||
\begin{enumerate}
|
||||
\item Implement the intervention in [settings].
|
||||
\item Train practitioners using the standardized protocol.
|
||||
\item Monitor outcomes using the validated measures.
|
||||
\end{enumerate}
|
||||
\end{recommendations}
|
||||
```
|
||||
|
||||
### Methods Section Example
|
||||
|
||||
```latex
|
||||
\chapter{Methods}
|
||||
|
||||
\begin{methodology}[Study Overview]
|
||||
This randomized controlled trial employed a parallel-group design with
|
||||
1:1 allocation to intervention or control conditions. The study was
|
||||
conducted across 12 sites between January 2023 and December 2024.
|
||||
\end{methodology}
|
||||
|
||||
\section{Participants}
|
||||
|
||||
A total of \samplesize{450} participants were enrolled. Eligibility
|
||||
criteria were:
|
||||
|
||||
\begin{itemize}
|
||||
\item Age 18--65 years
|
||||
\item Diagnosis of [condition] per [criteria]
|
||||
\item No contraindications to [intervention]
|
||||
\end{itemize}
|
||||
|
||||
Table~\ref{tab:participants} presents participant characteristics.
|
||||
|
||||
\begin{limitations}[Recruitment Challenges]
|
||||
Recruitment was slower than anticipated due to [reasons]. The final
|
||||
sample was 10% below target, which may affect statistical power for
|
||||
secondary analyses.
|
||||
\end{limitations}
|
||||
```
|
||||
|
||||
### Results Section Example
|
||||
|
||||
```latex
|
||||
\chapter{Results}
|
||||
|
||||
\section{Primary Outcome}
|
||||
|
||||
\begin{resultsbox}[Primary Analysis]
|
||||
Mixed-effects regression revealed a significant treatment effect,
|
||||
\effectsize{F(1, 448)}{42.18}, \psig{< 0.001}, with a large effect
|
||||
size (\effectsize{d}{0.82}). The treatment group showed significantly
|
||||
greater improvement (\meansd{16.4}{5.2} points) compared to control
|
||||
(\meansd{8.1}{4.8} points).
|
||||
\end{resultsbox}
|
||||
|
||||
Figure~\ref{fig:primary} illustrates the treatment effects over time.
|
||||
|
||||
\begin{figure}[htbp]
|
||||
\centering
|
||||
\includegraphics[width=0.9\textwidth]{../figures/primary_outcome.png}
|
||||
\caption{Primary Outcome Scores by Treatment Group and Time Point}
|
||||
\figurenote{Error bars represent 95\% confidence intervals.}
|
||||
\label{fig:primary}
|
||||
\end{figure}
|
||||
|
||||
\section{Secondary Outcomes}
|
||||
|
||||
Results for secondary outcomes are presented in Table~\ref{tab:secondary}.
|
||||
```
|
||||
|
||||
### Discussion Section Example
|
||||
|
||||
```latex
|
||||
\chapter{Discussion}
|
||||
|
||||
\section{Summary of Findings}
|
||||
|
||||
\begin{keyfindings}[Main Conclusions]
|
||||
\begin{enumerate}
|
||||
\item The intervention was highly effective (primary hypothesis
|
||||
\highlight{supported})
|
||||
\item Effects were clinically meaningful and durable
|
||||
\item Evidence strength: \evidencestrong
|
||||
\end{enumerate}
|
||||
\end{keyfindings}
|
||||
|
||||
\section{Limitations}
|
||||
|
||||
\begin{limitations}
|
||||
Several limitations warrant consideration:
|
||||
\begin{itemize}
|
||||
\item The sample was predominantly [demographic], limiting
|
||||
generalizability.
|
||||
\item Attrition was higher in the control group (18\% vs. 12\%).
|
||||
\item Self-report measures may be subject to response bias.
|
||||
\end{itemize}
|
||||
\end{limitations}
|
||||
|
||||
\section{Implications}
|
||||
|
||||
\begin{recommendations}[Research Implications]
|
||||
\begin{enumerate}
|
||||
\item Replicate in diverse populations
|
||||
\item Investigate mechanisms of change
|
||||
\item Test implementation strategies
|
||||
\end{enumerate}
|
||||
\end{recommendations}
|
||||
|
||||
\begin{recommendations}[Practice Implications]
|
||||
\begin{enumerate}
|
||||
\item Adopt the intervention in [settings]
|
||||
\item Train providers using standardized protocols
|
||||
\item Monitor fidelity and outcomes
|
||||
\end{enumerate}
|
||||
\end{recommendations}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Checklist: Professional Report Quality
|
||||
|
||||
Before finalizing your report, verify:
|
||||
|
||||
### Formatting
|
||||
- [ ] Using `scientific_report.sty` package
|
||||
- [ ] Compiled with XeLaTeX or LuaLaTeX
|
||||
- [ ] Helvetica font rendering correctly
|
||||
- [ ] Colors displaying properly
|
||||
|
||||
### Content Organization
|
||||
- [ ] Executive summary present and complete
|
||||
- [ ] Key findings highlighted in boxes
|
||||
- [ ] Methods clearly described
|
||||
- [ ] Results properly formatted with statistics
|
||||
- [ ] Limitations acknowledged
|
||||
- [ ] Recommendations are specific and actionable
|
||||
|
||||
### Tables
|
||||
- [ ] All tables have captions and labels
|
||||
- [ ] Alternating row colors applied
|
||||
- [ ] Significance indicators explained
|
||||
- [ ] Numbers formatted consistently
|
||||
|
||||
### Figures
|
||||
- [ ] All figures have captions and labels
|
||||
- [ ] Sources attributed where appropriate
|
||||
- [ ] Resolution sufficient for printing (300 DPI)
|
||||
- [ ] Referenced in text
|
||||
|
||||
### Statistical Reporting
|
||||
- [ ] P-values reported appropriately
|
||||
- [ ] Effect sizes included
|
||||
- [ ] Confidence intervals where relevant
|
||||
- [ ] Sample sizes stated
|
||||
|
||||
### Professional Appearance
|
||||
- [ ] Consistent formatting throughout
|
||||
- [ ] No orphaned headers or widows
|
||||
- [ ] Page breaks at appropriate locations
|
||||
- [ ] References complete and formatted
|
||||
|
||||
---
|
||||
|
||||
## Resources
|
||||
|
||||
### Files in This Skill
|
||||
|
||||
- `assets/scientific_report.sty` - The LaTeX style package
|
||||
- `assets/scientific_report_template.tex` - Complete report template
|
||||
- `assets/REPORT_FORMATTING_GUIDE.md` - Quick reference guide
|
||||
|
||||
### Related Skills
|
||||
|
||||
- `venue-templates` - For journal manuscripts and conference papers
|
||||
- `scientific-schematics` - For generating diagrams and figures
|
||||
- `generate-image` - For creating illustrations and graphics
|
||||
|
||||
### External Resources
|
||||
|
||||
- [LaTeX Wikibook](https://en.wikibooks.org/wiki/LaTeX) - General LaTeX reference
|
||||
- [Booktabs Package Documentation](https://ctan.org/pkg/booktabs) - Professional table styling
|
||||
- [tcolorbox Package Documentation](https://ctan.org/pkg/tcolorbox) - Colored box environments
|
||||
|
||||
Reference in New Issue
Block a user