https://github.com/rstudio/demo-co-quarto-report
Example Quarto report on customer churn
https://github.com/rstudio/demo-co-quarto-report
Last synced: 5 months ago
JSON representation
Example Quarto report on customer churn
- Host: GitHub
- URL: https://github.com/rstudio/demo-co-quarto-report
- Owner: rstudio
- Created: 2023-08-11T16:38:33.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-11T16:48:21.000Z (over 1 year ago)
- Last Synced: 2024-08-13T07:11:10.411Z (8 months ago)
- Language: R
- Homepage: https://colorado.posit.co/rsc/demoCo-churn/
- Size: 8.28 MB
- Stars: 2
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - rstudio/demo-co-quarto-report - Example Quarto report on customer churn (R)
README
# DemoCo Customer Churn Quarto Report
This Quarto report summarizes customer churn for DemoCo, an example company.
- View the report on [Posit Connect](https://pub.current.posit.team/churn-report/)
- Play with the code on [Posit Cloud](https://posit.cloud/content/6644960)
## Build the reports
You can build the reports yourself on [Posit Cloud](https://posit.cloud/content/6644960).
1. **Render the HTML report:** Open `churn_report.qmd` and click on the drop-down arrow next to the *Render* button. Click *Render* *democo-html*.
2. **Render the PDF report:** Open `churn_report.qmd` and click on the drop-down arrow next to the *Render* button. Click *Render* *democo-pdf*.
### Change the product type
`churn_report.qmd` includes a [parameter](https://quarto.org/docs/computations/parameters.html#knitr), `product`, that controls which product type the report displays. There are three product types in the data: Standard, Premium, Professional.
**To change the product type:**
In the YAML header of `churn_report.qmd`, update the `value` field of the `product` parameter to "Premium" or "Professional", then click *Render*.
---
params:
product:
label: "Product type"
value: Professional
input: select
choices: [Standard, Premium, Professional]
---
### Publish to Posit Connect
We've published the HTML report to [Connect](https://pub.current.posit.team/churn-report/). The report is set to run once a week. You can publish the report to your own Connect account using the *Publish* button  in the RStudio IDE, found in the upper-right corner of the Editor pane. Click  \> *Posit Connect* \> *Publish document with source code* \> Add the URL of your Connect server \> *Publish*.
See this [guide](https://quarto.org/docs/publishing/rstudio-connect.html) for publishing Quarto documents for more details.
## Themes
Both the HTML and PDF reports use a [custom Quarto format](https://quarto.org/docs/extensions/formats.html). You can find the custom format in the `_extensions` directory.
## Customize the reports
You can also use this project as a template for your own reports.
Here are some ways to modify the reports:
- Change the color scheme of the plots by changing the [color palette object](https://github.com/rstudio/demo-co-quarto-report/blob/6a62b3d699ecf2614745d373631cf7f54e6d844e/churn_report.qmd#L20), defined in the first chunk of `churn_report.qmd`.
- Read in different data in `churn_report.qmd`, and create your own plots.
- Modify the theme by editing the Quarto extension located in `_extensions/democo`. For more information about custom Quarto HTML themes, see [this guide](https://quarto.org/docs/output-formats/html-themes.html).
- Change `logo-with-slogan.png` to change the logo image used in the HTML report.
- Change `logo.png` to change the logo image used in the PDF report.
- Update the PDF [extension color scheme](https://github.com/rstudio/demo-co-quarto-report/blob/587c5eb6c543aaf9e7702ec3f0ab6ce2fb77476e/_extensions/demopdf/demopdf.tex#L15) in `demopdf.tex`. `light` defines the side panel color and `dark` defines the title and heading font color