Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quarto-dev/quarto-r
R interface to quarto-cli
https://github.com/quarto-dev/quarto-r
Last synced: about 1 month ago
JSON representation
R interface to quarto-cli
- Host: GitHub
- URL: https://github.com/quarto-dev/quarto-r
- Owner: quarto-dev
- Created: 2021-02-02T20:14:10.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-26T16:31:03.000Z (about 2 months ago)
- Last Synced: 2024-04-26T17:36:47.098Z (about 2 months ago)
- Language: R
- Homepage: https://quarto-dev.github.io/quarto-r/
- Size: 4.35 MB
- Stars: 131
- Watchers: 10
- Forks: 19
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Lists
- awesome-quarto - R - [R](https://www.r-project.org/) interface package to Quarto CLI. (Libraries/Packages/Scripts)
- jimsghstars - quarto-dev/quarto-r - R interface to quarto-cli (R)
README
#
[![CRAN status](https://www.r-pkg.org/badges/version/quarto)](https://CRAN.R-project.org/package=quarto)
[![R-CMD-check](https://github.com/quarto-dev/quarto-r/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/quarto-dev/quarto-r/actions/workflows/R-CMD-check.yaml)[Quarto](https://quarto.org) is an open-source scientific and technical publishing system built on [Pandoc](https://pandoc.org).
The **quarto** package provides an R interface to frequently used operations in the Quarto Command Line Interface (CLI). The package is not a requirement for using Quarto with R. Rather, it provides an R interface to common Quarto operations for users who prefer to work in the R console rather than a terminal, and for package authors that want to programatically interface with Quarto.
Before using the Quarto R package, you should install the Quarto CLI from .
### Render and Preview
The following functions enable you to render and preview Quarto documents and projects:
| | |
|---------------------------|------------------------------------|
| [`quarto_render()`](https://quarto-dev.github.io/quarto-r/reference/quarto_render.html) | Render a file or project |
| [`quarto_preview()`](https://quarto-dev.github.io/quarto-r/reference/quarto_preview.html) | Live preview a file or project |
| [`quarto_preview_stop()`](https://quarto-dev.github.io/quarto-r/reference/quarto_preview.html) | Stop live previewing |
| [`quarto_serve()`](https://quarto-dev.github.io/quarto-r/reference/quarto_serve.html) | Server interactive document |### Publishing
These functions enable you to publish static and interactive documents, websites, and books to [Posit Connect](https://posit.co/products/enterprise/connect/) and [shinyapps.io](https://www.shinyapps.io/):
| | |
|---------------------------|------------------------------------|
| [`quarto_publish_doc()`](https://quarto-dev.github.io/quarto-r/reference/quarto_publish_doc.html) | Publish a document or presentation |
| [`quarto_publish_site()`](https://quarto-dev.github.io/quarto-r/reference/quarto_publish_doc.html) | Publish a website |
| [`quarto_publish_app()`](https://quarto-dev.github.io/quarto-r/reference/quarto_publish_doc.html) | Publish a document with Shiny application runtime |### Configuration
These functions enable you to inspect the Quarto installation as well as the metadata for Quarto documents and projects:
| | |
|---------------------------|------------------------------------|
| [`quarto_path()`](https://quarto-dev.github.io/quarto-r/reference/quarto_path.html) | Path to the Quarto binary |
| [`quarto_version()`](https://quarto-dev.github.io/quarto-r/reference/quarto_version.html) | Current version of Quarto |
| [`quarto_inspect()`](https://quarto-dev.github.io/quarto-r/reference/quarto_inspect.html) | Inspect metadata for a file or project |### Installing the package
Latest released version from CRAN
```r
# latest release version
install.packages("quarto")
```Latest dev version from Github
```r
# dev version
pak::pak("quarto-dev/quarto-r")
# or
remotes::install_github("quarto-dev/quarto-r")
```or Latest build of dev version from r-universe
```r
install.packages('quarto', repos = c('https://quarto-dev.r-universe.dev', 'https://cloud.r-project.org'))
```