Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Vinit-Sehgal committed Jan 16, 2024
0 parents commit 2be6d5e
Show file tree
Hide file tree
Showing 33 changed files with 6,921 additions and 0 deletions.
Binary file added .DS_Store
Binary file not shown.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.Rproj.user
.Rhistory
.RData
.Ruserdata

/.quarto/
62 changes: 62 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
This repo contains a [Quarto book](https://quarto.org/docs/books/) template for the EDAV final project.

## Follow these instructions carefully

*If you have any difficulties or have feedback of any kind, please [file an issue](https://github.com/jtr13/quarto-edav-template/issues) or ask questions in the [Discussions](https://github.com/jtr13/quarto-edav-template/discussions) section.*

[Video tutorial](https://www.youtube.com/watch?v=emgS2JI4jCk) (walkthrough of steps below)

### Copy this template (GitHub)

- [ ] 1. Click the green "Use this template" button above and choose "Create a new repository". If you don't see the "Use this template" option, log in to GitHub. DO NOT FORK THE REPO. Choose a descriptive name for your repo, such as "federalbudget" or "AIDSdeaths". (If you change your topic before you do any work, delete the repo and start over.)

- [ ] 2. Leave the setting for viewing the repo as "Public". (Otherwise, we will not be able to access your rendered book.)

- [ ] 3. In the Description field, write "Source files for EDAV final project" then click "Create repository".

### Set up Pages (GitHub)

- [ ] 1. You've now left the template page and are viewing your new repo on GitHub. On the home page, click Settings. Click the "Pages" section on the left. In the Build and Deployment section, set Source to "Deploy from a branch" (Classic Pages experience) and Branch to main with /docs folder. Click Save.

- [ ] 2. Click the little gear button near "About" on the top right side of the home page of the repo and check the "Use your Github Pages website" box under "Website". Click "Save changes". Test the link and you should see a web site with a stick figure on it. It may take a few minutes to build so if it's not working do a few more steps and then come back to check.

### Copy the repo link (GitHub)

- [ ] 1. Click the green Code button, choose "HTTPS" and copy the link below. It should have the format: https://github.com/[USERNAME]/[REPONAME].git

### Clone the repo (RStudio)

- [ ] 1. Clone your new repo with *File, New Project..., Version Control, Git* in RStudio. You will need to paste the link from the previous step in the Repository URL box. If it's not automatically populated, enter the repo name in the "Project directory name:" box. Choose the location of the project.

### Edit `_quarto.yml` (RStudio)

Tip: From the file pane in RStudio, open `README.md`, which contains these instructions. You can delete steps as you complete them.

- [ ] 1. Change the all caps info in the `title:`, `author:` and `repo-url` fields in the YAML (top) section of `_quarto.yml` to your info. (Note: it's very important to maintain the indenting structure in this file precisely as is -- be careful!)

### Render the book (RStudio)

- [ ] 1. If you haven't already, click "Help" "Check for Updates" to make sure you have the latest version of RStudio (and thus have Quarto installed.)

- [ ] 2. Render the web site locally by clicking the "Build" tap on the right and then "Render Book".

- [ ] 3. Use `browseURL("docs/index.html")` to view your book locally (or just open `docs/index.html` in a browser).

- [ ] 4. If it looks good, commit and push all changed files to GitHub.

(You will need to repeat steps 2 and 4 every time you wish to update the book on GitHub Pages.)

### Update README (GitHub or RStudio)

- [ ] 1. Delete the content of this **README** and add a short description of your project in its place. If you're working locally, be sure to commit and push the changes to GitHub.

### Optional

- [ ] 1. Choose a theme from [https://bootswatch.com/](https://bootswatch.com/) and replace "cosmo" in `_quarto.yml` with your prefered theme.

### Additional features

Please consult the official guide to **quarto** book websites: [https://quarto.org/docs/books/](https://quarto.org/docs/books/)



31 changes: 31 additions & 0 deletions _quarto.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
project:
type: book
output-dir: docs

execute:
echo: true

book:
title: "YOUR PROJECT TITLE"
author:
- AUTHOR1 (UNI1)
- AUTHOR2 (UNI2)
repo-url: https://github.com/YOUR_GITHUB_ACCOUNT/REPO_NAME
date: today
page-footer:
right: |
This book was built with <a href="https://quarto.org/">Quarto</a>.
repo-actions: [edit, issue]
chapters:
- index.qmd
- data.qmd
- results.qmd
- d3graph.qmd
- conclusion.qmd

format:
html:
theme: cosmo
code-fold: true


1 change: 1 addition & 0 deletions conclusion.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Conclusion
13 changes: 13 additions & 0 deletions d3graph.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Interactive graph

<style>
* {
font-family: sans-serif;
}
</style>

<div id="plot">
</div>

<script src="https://cdn.jsdelivr.net/npm/d3@7"></script>
<script src="scripts/myscript.js"></script>
5 changes: 5 additions & 0 deletions data.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Data

## Description

## Missing value analysis
Loading

0 comments on commit 2be6d5e

Please sign in to comment.