.
This commit is contained in:
97
Toolbox/docs/examples/sample-report.qmd
Normal file
97
Toolbox/docs/examples/sample-report.qmd
Normal file
@@ -0,0 +1,97 @@
|
||||
---
|
||||
title: "TSYS Documentation & Diagrams Sample Report"
|
||||
author: "TSYS Group"
|
||||
date: "2025-11-07"
|
||||
format:
|
||||
html:
|
||||
theme: cosmo
|
||||
toc: true
|
||||
pdf:
|
||||
documentclass: article
|
||||
docx:
|
||||
reference-doc: template.docx
|
||||
jupyter: python3
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
This report demonstrates the capabilities of Quarto for creating reproducible scientific reports. Quarto is a powerful open-source scientific and technical publishing system that supports multiple input formats, numerous output formats, and integrates with R, Python, Julia, and Observable.
|
||||
|
||||
## Data Analysis with Python
|
||||
|
||||
We can embed code directly in the document:
|
||||
|
||||
```{python}
|
||||
#| echo: true
|
||||
import matplotlib.pyplot as plt
|
||||
import numpy as np
|
||||
|
||||
# Generate sample data
|
||||
x = np.linspace(0, 10, 100)
|
||||
y = np.sin(x)
|
||||
|
||||
# Create plot
|
||||
plt.figure(figsize=(10, 6))
|
||||
plt.plot(x, y, label='sin(x)')
|
||||
plt.title('Sine Wave')
|
||||
plt.xlabel('x')
|
||||
plt.ylabel('sin(x)')
|
||||
plt.legend()
|
||||
plt.grid(True)
|
||||
plt.show()
|
||||
```
|
||||
|
||||
## Mathematical Formulas
|
||||
|
||||
Quarto supports both inline math $E = mc^2$ and display math:
|
||||
|
||||
$$\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}$$
|
||||
|
||||
## Citations
|
||||
|
||||
We can reference academic works in our document. For example, research has shown the importance of reproducible research [@peng2009].
|
||||
|
||||
## Tables
|
||||
|
||||
| Tool | Purpose | Key Feature |
|
||||
|------|---------|-------------|
|
||||
| Pandoc | Document conversion | Universal converter |
|
||||
| mdBook | Book generation | Markdown-based |
|
||||
| Typst | Typesetting | Fast and modern |
|
||||
| Marp | Presentations | Markdown-based |
|
||||
| Quarto | Scientific publishing | Multi-language support |
|
||||
|
||||
## Diagrams
|
||||
|
||||
With integrated Kroki support, we can include diagrams:
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
A[Input Document] --> B{Quarto}
|
||||
B --> C[HTML Output]
|
||||
B --> D[PDF Output]
|
||||
B --> E[DOCX Output]
|
||||
B --> F[Beamer Slides]
|
||||
```
|
||||
|
||||
## Code Execution
|
||||
|
||||
Quarto allows executing code in multiple languages:
|
||||
|
||||
```{python}
|
||||
#| echo: true
|
||||
import pandas as pd
|
||||
|
||||
# Create sample data frame
|
||||
data = {'Name': ['Alice', 'Bob', 'Charlie'],
|
||||
'Age': [25, 30, 35],
|
||||
'City': ['New York', 'London', 'Tokyo']}
|
||||
df = pd.DataFrame(data)
|
||||
print(df)
|
||||
```
|
||||
|
||||
## Conclusion
|
||||
|
||||
This sample demonstrates Quarto's powerful features for creating reproducible, multi-format documents that combine narrative text, code, and output. The TSYS Documentation & Diagrams container provides all the necessary tools for comprehensive document production workflows.
|
||||
|
||||
## References
|
||||
Reference in New Issue
Block a user