Skip to content

JBertolis/quarto_project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1 Commit
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Exploratory Data Analysis (EDA) Report – README

High‑level guide for someone new to Quarto and this project.


πŸš€ What is this?

  • This is a Quarto project configured as a book (multi‑chapter report). A Quarto project is simply a folder with a _quarto.yml file, which Quarto uses to manage and render multiple .qmd files together :contentReference[oaicite:0]{index=0}.
  • The _quarto.yml file sets project.type: book and lists the chapters in order under book.chapters, such as
    book:
      chapters:
        - index.qmd
        - 01-setup.qmd
        - 02-univariate.qmd
        - 03-correlations.qmd
    ``` :contentReference[oaicite:1]{index=1}.
    

πŸ› οΈ Prerequisites

  • Install Quarto CLI from quarto.org. Make sure the version is β‰₯β€―1.0. You can verify with:
  quarto --version

Ensure Python 3.9+, Jupyter, and packages like numpy, pandas, matplotlib, seaborn are installed. Use:

pip install -r requirements.txt
# or
conda env create -f environment.yml

πŸ“ Project Structure

.
β”œβ”€β”€ _quarto.yml          # Quarto project config (book type + format settings)
β”œβ”€β”€ README.md            # You are here
β”œβ”€β”€ index.qmd            # Preface / Overview
β”œβ”€β”€ 01-setup.qmd         # Data loading and cleaning
β”œβ”€β”€ 02-univariate.qmd    # Single-variable stats & plots
β”œβ”€β”€ 03-correlations.qmd  # Pairwise and regression analyses
β”œβ”€β”€ data/                # Data files (.csv, .tsv, Parquet, etc.)
β”œβ”€β”€ src/                 # Python modules (e.g. src/eda.py)
β”œβ”€β”€ tests/               # Pytest tests for code in src/
└── environment.yml      # Optional conda env specification
  • The folder acts as a Quarto project because of the _quarto.yml config file
  • Every .qmd chapter renders via the book engine, producing both HTML and PDF according to the formats defined in _quarto.yml.

πŸ“– How to Render the Book

  • To render the book, run:
quarto render
  • This generates HTML and PDF files in the _site folder (default output location).
  • To view the HTML book, open _site/index.html in a web browser.
  • To render a specific chapter, use:
quarto render 01-setup.qmd
  • To render all chapters, simply run quarto render without specifying a chapter.
  • To render to a specific format, use:
quarto render --to html
  • or
quarto render --to pdf

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published