diff --git a/404.html b/404.html index 9e5ec92..a7fecc7 100644 --- a/404.html +++ b/404.html @@ -27,7 +27,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/CODE_OF_CONDUCT.html b/CODE_OF_CONDUCT.html index 3f947b3..02ae432 100644 --- a/CODE_OF_CONDUCT.html +++ b/CODE_OF_CONDUCT.html @@ -7,7 +7,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/CONTRIBUTING.html b/CONTRIBUTING.html index 8fc220e..b145d99 100644 --- a/CONTRIBUTING.html +++ b/CONTRIBUTING.html @@ -7,7 +7,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/articles/hello-pdf.pdf b/articles/hello-pdf.pdf index c859a8e..4ff7da2 100644 Binary files a/articles/hello-pdf.pdf and b/articles/hello-pdf.pdf differ diff --git a/articles/hello.html b/articles/hello.html index 25015f8..fa881c7 100644 --- a/articles/hello.html +++ b/articles/hello.html @@ -29,7 +29,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/articles/index.html b/articles/index.html index 1995616..e458275 100644 --- a/articles/index.html +++ b/articles/index.html @@ -7,7 +7,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/articles/publishing.html b/articles/publishing.html index beb33dd..f94f96b 100644 --- a/articles/publishing.html +++ b/articles/publishing.html @@ -29,7 +29,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/authors.html b/authors.html index 1841cbb..9344891 100644 --- a/authors.html +++ b/authors.html @@ -7,7 +7,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 @@ -59,14 +59,14 @@ Citation Allaire J, Dervieux C (2024). quarto: R Interface to 'Quarto' Markdown Publishing System. -R package version 1.4.4.9000, +R package version 1.4.4.9001, https://quarto-dev.github.io/quarto-r/, https://github.com/quarto-dev/quarto-r. @Manual{, title = {quarto: R Interface to 'Quarto' Markdown Publishing System}, author = {JJ Allaire and Christophe Dervieux}, year = {2024}, - note = {R package version 1.4.4.9000, + note = {R package version 1.4.4.9001, https://quarto-dev.github.io/quarto-r/}, url = {https://github.com/quarto-dev/quarto-r}, } diff --git a/index.html b/index.html index 183d862..ee19fbc 100644 --- a/index.html +++ b/index.html @@ -29,7 +29,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/news/index.html b/news/index.html index f03d6ab..0367223 100644 --- a/news/index.html +++ b/news/index.html @@ -7,7 +7,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 @@ -39,7 +39,8 @@ quarto (development version) - +Add quarto.quiet options to allow more verbose error message when quarto_* function are used inside other package. For example, inside pkgdown for building Quarto vignettes. pkgdown sets quiet = TRUE internally for its call to quarto_render(), and setting options(quarto.quiet = TRUE) allows to overwrite this. + quarto 1.4.4CRAN release: 2024-07-20 quarto_preview() now looks at quarto preview log to browse to the correct url when inside RStudio viewer (thanks, @aronatkins, #167). diff --git a/pkgdown.yml b/pkgdown.yml index a4f2699..76e7228 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -5,7 +5,7 @@ articles: hello-pdf: hello-pdf.pdf hello: hello.html publishing: publishing.html -last_built: 2024-07-23T09:55Z +last_built: 2024-07-23T09:58Z urls: reference: https://quarto-dev.github.io/quarto-r/reference article: https://quarto-dev.github.io/quarto-r/articles diff --git a/reference/index.html b/reference/index.html index c7d6cde..7d29697 100644 --- a/reference/index.html +++ b/reference/index.html @@ -7,7 +7,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/reference/is_using_quarto.html b/reference/is_using_quarto.html index ec30408..8a4b8b6 100644 --- a/reference/is_using_quarto.html +++ b/reference/is_using_quarto.html @@ -15,7 +15,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/reference/quarto-package.html b/reference/quarto-package.html index b42db54..3c0d7a6 100644 --- a/reference/quarto-package.html +++ b/reference/quarto-package.html @@ -9,7 +9,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/reference/quarto_add_extension.html b/reference/quarto_add_extension.html index 06834b6..c8ecab8 100644 --- a/reference/quarto_add_extension.html +++ b/reference/quarto_add_extension.html @@ -7,7 +7,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/reference/quarto_binary_sitrep.html b/reference/quarto_binary_sitrep.html index 1ebe9b8..3ffdb0c 100644 --- a/reference/quarto_binary_sitrep.html +++ b/reference/quarto_binary_sitrep.html @@ -9,7 +9,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/reference/quarto_create_project.html b/reference/quarto_create_project.html index e3fa988..fb37326 100644 --- a/reference/quarto_create_project.html +++ b/reference/quarto_create_project.html @@ -11,7 +11,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/reference/quarto_inspect.html b/reference/quarto_inspect.html index e7dec0c..7712553 100644 --- a/reference/quarto_inspect.html +++ b/reference/quarto_inspect.html @@ -11,7 +11,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/reference/quarto_path.html b/reference/quarto_path.html index 1f95a84..218a703 100644 --- a/reference/quarto_path.html +++ b/reference/quarto_path.html @@ -9,7 +9,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/reference/quarto_preview.html b/reference/quarto_preview.html index 9ef0d90..41586de 100644 --- a/reference/quarto_preview.html +++ b/reference/quarto_preview.html @@ -7,7 +7,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/reference/quarto_publish_doc.html b/reference/quarto_publish_doc.html index b64e7c7..525ede1 100644 --- a/reference/quarto_publish_doc.html +++ b/reference/quarto_publish_doc.html @@ -7,7 +7,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/reference/quarto_render.html b/reference/quarto_render.html index 510b0c6..2bc56d9 100644 --- a/reference/quarto_render.html +++ b/reference/quarto_render.html @@ -11,7 +11,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/reference/quarto_serve.html b/reference/quarto_serve.html index 74cfd6d..b1d557c 100644 --- a/reference/quarto_serve.html +++ b/reference/quarto_serve.html @@ -11,7 +11,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/reference/quarto_use_template.html b/reference/quarto_use_template.html index dcdeb67..7e46e5b 100644 --- a/reference/quarto_use_template.html +++ b/reference/quarto_use_template.html @@ -7,7 +7,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/reference/quarto_version.html b/reference/quarto_version.html index 3b7c88f..d22f845 100644 --- a/reference/quarto_version.html +++ b/reference/quarto_version.html @@ -9,7 +9,7 @@ quarto - 1.4.4.9000 + 1.4.4.9001 diff --git a/search.json b/search.json index f83852b..5ae51a9 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":[]},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement codeofconduct@posit.co. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to quarto","title":"Contributing to quarto","text":"welcome contributions quarto R package. can contribute many ways: opening issues give feedback share ideas. fixing typos documentations submitting Pull Request (PR) fix opened issues submitting Pull Request (PR) suggest new features. (considered good practice open issues discuss ideas)","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CONTRIBUTING.html","id":"to-submit-a-contribution-using-a-pull-request","dir":"","previous_headings":"","what":"To submit a contribution using a Pull Request:","title":"Contributing to quarto","text":"Fork repository make changes new branch specific PR. ok edit file repository using Edit button Github change simple enough. significant changes (e.g required fixing typos), ensure signed individual corporate contributor agreement appropriate. can send signed copy contribute@posit.co. Submit pull request. ok submit draft still working like feedback us. always good share open working . ’ll try responsive possible reviewing accepting pull requests. Appreciate contributions much!","code":""},{"path":"https://quarto-dev.github.io/quarto-r/articles/hello.html","id":"quarto-as-vignette-builder","dir":"Articles","previous_headings":"","what":"Quarto as vignette builder","title":"Quarto HTML Vignettes","text":"Add DESCRIPTION file:","code":"VignetteBuilder: quarto"},{"path":"https://quarto-dev.github.io/quarto-r/articles/hello.html","id":"html-vignette-engines","dir":"Articles","previous_headings":"","what":"HTML Vignette Engines","title":"Quarto HTML Vignettes","text":"quarto R package registers vignette engines can used %\\VignetteEngine{} directives vignette headers. learn vignettes engine works, write vignette engines, see Writing R Extensions manual R Packages (2e) book. produce HTML vignette engine, add YAML header build HTML document using Quarto, suitable using vignette publish CRAN. Choice made create minimal HTML vignette default, built following changes based Quarto’s format: html defaults: HTML file produced standalone (.e. embed-resources: true) Bootstrap disabled (.e. theme: none minimal: true) custom CSS file provided. equivalent configurations set way can’t overriden YAML header vignette source file new configurations can set. Typical examples configurations adding table contents enabling rendering mathematical notation format options, e.g., MathJax. Specifically, two options can set following way: minimal default format deliberate limitation current implementation vignette engine. ensures HTML vignettes produced reasonable size can published CRAN without problems. Another limitation concerns interactive rendering. render vignette .qmd file using quarto render function, output based default HTML format Quarto vignette engine one. building vignette produce real results. details building vignettes available R Packages (2e) book. Intermediates resources created authoring workflow quarto render default format: html ignored package sources. Added .Rbuildignore (e.g usethis::use_build_ignore(\"vignettes/*_files\")) Added .gitignore (e.g. usethis::use_git_ignore(\"*_files\", \"vignettes\"))","code":"vignette: > %\\VignetteIndexEntry{Vignette's Title} %\\VignetteEngine{quarto::html} %\\VignetteEncoding{UTF-8} --- format: html: theme: none minimal: true embed-resources: true css: custom.css format: html: toc: true html-math-method: mathjax vignette: > %\\VignetteIndexEntry{Vignette's Title} %\\VignetteEngine{quarto::html} %\\VignetteEncoding{UTF-8}"},{"path":"https://quarto-dev.github.io/quarto-r/articles/publishing.html","id":"overview","dir":"Articles","previous_headings":"","what":"Overview","title":"Publishing","text":"quarto package includes several functions enable publish static interactive documents, websites, books Posit Connect shinyapps.io. publishing Posit Connect, simple content publishing (local rendering) well code publishing (rendering Connect) supported.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/articles/publishing.html","id":"accounts","dir":"Articles","previous_headings":"","what":"Accounts","title":"Publishing","text":"publishing Posit Connect shinyapps.io ensure account configured publishing. Posit Connect, use rsconnect::connectUser() function server publishing . example: ’ll prompted authoring account web browser. shinyapps.io, use rsconnect::setAccountInfo() function. example: Note can copy paste code Tokens page shinyapps.io admin panel.","code":"rsconnect::connectUser(server = \"rsc.example.com\") rsconnect::setAccountInfo(name = 'norahjones', token = 'AB6783FD23', secret = '36x+k0bBy6W')"},{"path":"https://quarto-dev.github.io/quarto-r/articles/publishing.html","id":"documents","dir":"Articles","previous_headings":"","what":"Documents","title":"Publishing","text":"Use quarto_publish_doc() function publish single document Posit Connect. Note first time publish specify server account want use publishing. example: Subsequent updates document don’t need specify server account: example renders content locally publishes just content server. can also render server (uploading source code required render). might want order create scheduled versions report update automatically underlying data changes. , add render = \"server\" argument:","code":"library(quarto) quarto_publish_doc(\"document.qmd\", server = \"rsc.example.com\", account = \"njones\") quarto_publish_doc(\"document.qmd\") quarto_publish_doc(\"document.qmd\", server = \"rsc.example.com\", account = \"njones\", render = \"server\")"},{"path":"https://quarto-dev.github.io/quarto-r/articles/publishing.html","id":"websites","dir":"Articles","previous_headings":"","what":"Websites","title":"Publishing","text":"Use quarto_publish_site() function publish website book Posit Connect. Note first time publish specify server account want use publishing. example: Subsequent updates site don’t need specify server account: example renders content locally publishes just content server. can also render server (uploading source code required render). might want order create scheduled versions website update automatically underlying data changes. , add render = \"server\" argument:","code":"library(quarto) quarto_publish_site(server = \"rsc.example.com\", account = \"njones\") quarto_publish_site() quarto_publish_site(server = \"rsc.example.com\", account = \"njones\", render = \"server\")"},{"path":"https://quarto-dev.github.io/quarto-r/articles/publishing.html","id":"interactive-docs","dir":"Articles","previous_headings":"","what":"Interactive Docs","title":"Publishing","text":"can publish Shiny interactive documents either Posit Connect shinyapps.io. publish Posit Connect, specify server account want use publishing (required first publish ). example: publish shinyapps.io, use server = \"shinyapps.io\": services, subsequent publishes need provide server account:","code":"library(quarto) quarto_publish_app(\"shiny.qmd\", server = \"rsc.example.com\", account = \"njones\") quarto_publish_app(\"shiny.qmd\", server = \"shinyapps.io\") quarto_publish_app(\"shiny.qmd\")"},{"path":"https://quarto-dev.github.io/quarto-r/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"JJ Allaire. Author. Christophe Dervieux. Maintainer, author. Posit Software, PBC. Copyright holder, funder.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Allaire J, Dervieux C (2024). quarto: R Interface 'Quarto' Markdown Publishing System. R package version 1.4.4.9000, https://quarto-dev.github.io/quarto-r/, https://github.com/quarto-dev/quarto-r.","code":"@Manual{, title = {quarto: R Interface to 'Quarto' Markdown Publishing System}, author = {JJ Allaire and Christophe Dervieux}, year = {2024}, note = {R package version 1.4.4.9000, https://quarto-dev.github.io/quarto-r/}, url = {https://github.com/quarto-dev/quarto-r}, }"},{"path":"https://quarto-dev.github.io/quarto-r/index.html","id":"quarto-","dir":"","previous_headings":"","what":"R Interface to Quarto Markdown Publishing System","title":"R Interface to Quarto Markdown Publishing System","text":"Quarto open-source scientific technical publishing system built Pandoc. quarto package provides R interface frequently used operations Quarto Command Line Interface (CLI). package requirement using Quarto R. Rather, provides R interface common Quarto operations users prefer work R console rather terminal, package authors want interface Quarto using scripts. using Quarto R package, install Quarto CLI https://quarto.org/docs/get-started/.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/index.html","id":"installing-the-package","dir":"","previous_headings":"","what":"Installing the package","title":"R Interface to Quarto Markdown Publishing System","text":"Latest released version CRAN Latest dev version Github Latest build dev version r-universe Look Functions Reference page see list functions available package.","code":"# latest release version install.packages(\"quarto\") # dev version pak::pak(\"quarto-dev/quarto-r\") # or remotes::install_github(\"quarto-dev/quarto-r\") install.packages('quarto', repos = c('https://quarto-dev.r-universe.dev', 'https://cloud.r-project.org'))"},{"path":"https://quarto-dev.github.io/quarto-r/reference/is_using_quarto.html","id":null,"dir":"Reference","previous_headings":"","what":"Check is a directory is using quarto — is_using_quarto","title":"Check is a directory is using quarto — is_using_quarto","text":"function check directory using quarto looking _quarto.yml root least one .qmd file directory","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/is_using_quarto.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check is a directory is using quarto — is_using_quarto","text":"","code":"is_using_quarto(dir = \".\", verbose = FALSE)"},{"path":"https://quarto-dev.github.io/quarto-r/reference/is_using_quarto.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check is a directory is using quarto — is_using_quarto","text":"dir directory check verbose print message result check","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/is_using_quarto.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check is a directory is using quarto — is_using_quarto","text":"","code":"dir.create(tmpdir <- tempfile()) is_using_quarto(tmpdir) #> [1] FALSE file.create(file.path(tmpdir, \"_quarto.yml\")) #> [1] TRUE is_using_quarto(tmpdir) #> [1] TRUE unlink(tmpdir, recursive = TRUE)"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto-package.html","id":null,"dir":"Reference","previous_headings":"","what":"quarto: R Interface to 'Quarto' Markdown Publishing System — quarto-package","title":"quarto: R Interface to 'Quarto' Markdown Publishing System — quarto-package","text":"Convert R Markdown documents 'Jupyter' notebooks variety output formats using 'Quarto'.","code":""},{"path":[]},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"quarto: R Interface to 'Quarto' Markdown Publishing System — quarto-package","text":"Maintainer: Christophe Dervieux cderv@posit.co (ORCID) Authors: JJ Allaire jj@posit.co (ORCID) contributors: Posit Software, PBC [copyright holder, funder]","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_add_extension.html","id":null,"dir":"Reference","previous_headings":"","what":"Install a Quarto extensions — quarto_add_extension","title":"Install a Quarto extensions — quarto_add_extension","text":"Add extension folder project running quarto add","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_add_extension.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install a Quarto extensions — quarto_add_extension","text":"","code":"quarto_add_extension( extension = NULL, no_prompt = FALSE, quiet = FALSE, quarto_args = NULL )"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_add_extension.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install a Quarto extensions — quarto_add_extension","text":"extension extension install, either archive GitHub repository described documentation https://quarto.org/docs/extensions/managing.html. no_prompt prompt confirm approval download external extension. quiet Suppress warning messages. quarto_args Character vector quarto CLI arguments append Quarto command executed function. mainly intended advanced usage useful CLI arguments yet mirrored dedicated parameter R function. See quarto render --help options.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_add_extension.html","id":"extension-trust","dir":"Reference","previous_headings":"","what":"Extension Trust","title":"Install a Quarto extensions — quarto_add_extension","text":"Quarto extensions may execute code documents rendered. Therefore, trust author extension, recommend install use extension. default no_prompt = FALSE means function ask explicit approval used interactively, disallow installation.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_add_extension.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install a Quarto extensions — quarto_add_extension","text":"","code":"if (FALSE) { # \\dontrun{ # Install a template and set up a draft document from a GitHub repository quarto_add_extension(\"quarto-ext/fontawesome\") # Install a template and set up a draft document from a ZIP archive quarto_add_extension(\"https://github.com/quarto-ext/fontawesome/archive/refs/heads/main.zip\") } # }"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_binary_sitrep.html","id":null,"dir":"Reference","previous_headings":"","what":"Check configurations for quarto binary used — quarto_binary_sitrep","title":"Check configurations for quarto binary used — quarto_binary_sitrep","text":"function check configuration quarto package R package detect possible difference version used RStudio IDE.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_binary_sitrep.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check configurations for quarto binary used — quarto_binary_sitrep","text":"","code":"quarto_binary_sitrep(verbose = TRUE, debug = FALSE)"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_binary_sitrep.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check configurations for quarto binary used — quarto_binary_sitrep","text":"verbose FALSE, return result check. debug TRUE, print information value set configurations.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_binary_sitrep.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check configurations for quarto binary used — quarto_binary_sitrep","text":"TRUE package using quarto binary RStudio IDE. FALSE otherwise difference detected quarto found. Use verbose = TRUE ordebug = TRUE get detailed information.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_binary_sitrep.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check configurations for quarto binary used — quarto_binary_sitrep","text":"","code":"quarto_binary_sitrep(verbose = FALSE) #> [1] TRUE quarto_binary_sitrep(verbose = TRUE) #> ✔ quarto R package will use /opt/quarto/bin/quarto #> [1] TRUE quarto_binary_sitrep(debug = TRUE) #> ✔ quarto R package will use /opt/quarto/bin/quarto #> ℹ It is configured to use the latest version found in the PATH environment variable. #> [1] TRUE"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_create_project.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a quarto project — quarto_create_project","title":"Create a quarto project — quarto_create_project","text":"function calls quarto create project . create new directory project name add skeletons files project type chosen.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_create_project.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a quarto project — quarto_create_project","text":"","code":"quarto_create_project( name, type = \"default\", dir = \".\", no_prompt = FALSE, quiet = FALSE, quarto_args = NULL )"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_create_project.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a quarto project — quarto_create_project","text":"name name project directory created. type type project create. 1.4, can one default, website, blog, book, manuscript, confluence. dir directory create new Quarto project. no_prompt prompt confirm approval download external extension. quiet Suppress warning messages. quarto_args Character vector quarto CLI arguments append Quarto command executed function. mainly intended advanced usage useful CLI arguments yet mirrored dedicated parameter R function. See quarto render --help options.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_create_project.html","id":"quarto-version-required","dir":"Reference","previous_headings":"","what":"Quarto version required","title":"Create a quarto project — quarto_create_project","text":"function require Quarto 1.4 higher. Use quarto_version()check version Quarto detected.","code":""},{"path":[]},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_inspect.html","id":null,"dir":"Reference","previous_headings":"","what":"Inspect Quarto Input File or Project — quarto_inspect","title":"Inspect Quarto Input File or Project — quarto_inspect","text":"Inspect Quarto project input path. Inspecting project returns config engines. Inspecting input path return formats, engine, dependent resources.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_inspect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Inspect Quarto Input File or Project — quarto_inspect","text":"","code":"quarto_inspect(input = \".\", profile = NULL, quiet = FALSE, quarto_args = NULL)"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_inspect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Inspect Quarto Input File or Project — quarto_inspect","text":"input input file project directory inspect. profile Quarto project profile(s) use. Either character vector profile names NULL use default profile. quiet Suppress warning messages. quarto_args Character vector quarto CLI arguments append Quarto command executed function. mainly intended advanced usage useful CLI arguments yet mirrored dedicated parameter R function. See quarto render --help options.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_inspect.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Inspect Quarto Input File or Project — quarto_inspect","text":"Named list. input files, list contains elements quarto, engines, formats, resources, plus project file part Quarto project. projects, list contains elements quarto, dir, engines, config files.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_inspect.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Inspect Quarto Input File or Project — quarto_inspect","text":"","code":"if (FALSE) { # \\dontrun{ # Inspect input file file quarto_inspect(\"notebook.Rmd\") # Inspect project quarto_inspect(\"myproject\") # Inspect project's advanced profile quarto_inspect( input = \"myproject\", profile = \"advanced\" ) } # }"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_path.html","id":null,"dir":"Reference","previous_headings":"","what":"Path to the quarto binary — quarto_path","title":"Path to the quarto binary — quarto_path","text":"Determine path quarto binary. Uses QUARTO_PATH environment variable defined, otherwise uses Sys.().","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_path.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Path to the quarto binary — quarto_path","text":"","code":"quarto_path()"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_path.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Path to the quarto binary — quarto_path","text":"Path quarto binary (NULL found)","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_preview.html","id":null,"dir":"Reference","previous_headings":"","what":"Quarto Preview — quarto_preview","title":"Quarto Preview — quarto_preview","text":"Render preview Quarto document website project.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_preview.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Quarto Preview — quarto_preview","text":"","code":"quarto_preview( file = NULL, render = \"auto\", port = \"auto\", host = \"127.0.0.1\", browse = TRUE, watch = TRUE, navigate = TRUE ) quarto_preview_stop()"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_preview.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Quarto Preview — quarto_preview","text":"file document website project directory preview (defaults current working directory) render website preview, recent execution results computational documents used render site (optimize startup time). want perform full render prior serving pass \"\" vector specific formats render. Pass \"default\" render default format site. document preview, document rendered prior preview (pass FALSE override ). port Port listen (defaults 4848) host Hostname bind (defaults 127.0.0.1) browse Open browser preview content. Defaults using RStudio Viewer running within RStudio.Pass function (e.g. utils::browseURL override behavior). watch Watch changes automatically reload browser. navigate Automatically navigate preview browser recently rendered document.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_preview.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Quarto Preview — quarto_preview","text":"Automatically reloads browser input files re-rendered document resources (e.g. CSS) change.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_preview.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Quarto Preview — quarto_preview","text":"","code":"if (FALSE) { # \\dontrun{ # Preview the project in the current directory quarto_preview() # Preview a document quarto_preview(\"document.qmd\") # Preview the project in \"myproj\" directory and use external browser # (rather than RStudio Viewer) quarto_preview(\"myproj\", open = utils::browseURL) # Stop any running quarto preview quarto_preview_stop() } # }"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_publish_doc.html","id":null,"dir":"Reference","previous_headings":"","what":"Publish Quarto Documents — quarto_publish_doc","title":"Publish Quarto Documents — quarto_publish_doc","text":"Publish Quarto documents Posit Connect, ShinyApps, RPubs","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_publish_doc.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Publish Quarto Documents — quarto_publish_doc","text":"","code":"quarto_publish_doc( input, name = NULL, title = NULL, server = NULL, account = NULL, render = c(\"local\", \"server\", \"none\"), metadata = list(), ... ) quarto_publish_app( input = getwd(), name = NULL, title = NULL, server = NULL, account = NULL, render = c(\"local\", \"server\", \"none\"), metadata = list(), ... ) quarto_publish_site( input = getwd(), name = NULL, title = NULL, server = NULL, account = NULL, render = c(\"local\", \"server\", \"none\"), metadata = list(), ... )"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_publish_doc.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Publish Quarto Documents — quarto_publish_doc","text":"input input file project directory published. Defaults current working directory. name Name publishing (names must unique within account). Defaults name input. title Free-form descriptive title application. Optional; supplied, often displayed favor name. deploying new document, may supply title receive auto-generated name account, server Uniquely identify remote server either user account, server name, . neither supplied, multiple options, prompted pick one. Use accounts() see full list available options. render local render locally publishing; server render server; none use whatever rendered content currently exists locally. (defaults local) metadata Additional metadata fields save deployment record. fields returned subsequent calls deployments(). Multi-value fields recorded comma-separated values returned form. Custom value serialization responsibility caller. ... Named parameters pass along rsconnect::deployApp()","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_publish_doc.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Publish Quarto Documents — quarto_publish_doc","text":"","code":"if (FALSE) { # \\dontrun{ library(quarto) quarto_publish_doc(\"mydoc.qmd\") quarto_publish_app(server = \"shinyapps.io\") quarto_publish_site(server = \"rstudioconnect.example.com\") } # }"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_render.html","id":null,"dir":"Reference","previous_headings":"","what":"Render Markdown — quarto_render","title":"Render Markdown — quarto_render","text":"Render input file specified output format using quarto. input requires computations (e.g. Rmd Jupyter files) computations performed rendering.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_render.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Render Markdown — quarto_render","text":"","code":"quarto_render( input = NULL, output_format = NULL, output_file = NULL, execute = TRUE, execute_params = NULL, execute_dir = NULL, execute_daemon = NULL, execute_daemon_restart = FALSE, execute_debug = FALSE, use_freezer = FALSE, cache = NULL, cache_refresh = FALSE, metadata = NULL, metadata_file = NULL, debug = FALSE, quiet = FALSE, profile = NULL, quarto_args = NULL, pandoc_args = NULL, as_job = getOption(\"quarto.render_as_job\", \"auto\") )"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_render.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Render Markdown — quarto_render","text":"input input file project directory rendered (defaults rendering project current working directory). output_format Target output format (defaults \"html\"). option \"\" render formats defined within file project. output_file name output file. using NULL, output filename based filename input file. output_file mapped --output option flag quarto CLI. expected filename , path, relative absolute. execute Whether execute embedded code chunks. execute_params list named parameters override custom params specified within YAML front-matter. execute_dir working directory execute embedded code chunks. execute_daemon Keep Jupyter kernel alive (defaults 300 seconds). Note option applicable rendering Jupyter notebooks Jupyter markdown. execute_daemon_restart Restart keepalive Jupyter kernel render. Note option applicable rendering Jupyter notebooks Jupyter markdown. execute_debug Show debug output Jupyter kernel. use_freezer Force use frozen computations incremental file render. cache Cache execution output (uses knitr cache jupyter-cache respectively Rmd Jupyter input files). cache_refresh Force refresh execution cache. metadata optional named list used override YAML metadata. passed YAML file --metadata-file CLI flag. merged metadata-file options specified. metadata_file yaml file passed --metadata-file CLI flags override metadata. merged metadata specified, low precedence metadata options. debug Leave intermediate files place render. quiet Suppress warning messages. profile Quarto project profile(s) use. Either character vector profile names NULL use default profile. quarto_args Character vector quarto CLI arguments append Quarto command executed function. mainly intended advanced usage useful CLI arguments yet mirrored dedicated parameter R function. See quarto render --help options. pandoc_args Additional command line arguments pass Pandoc. as_job Render RStudio background job. Default \"auto\", render individual documents normally projects background jobs. Use quarto.render_as_job R option control default globally.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_render.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Render Markdown — quarto_render","text":"","code":"if (FALSE) { # \\dontrun{ # Render R Markdown quarto_render(\"notebook.Rmd\") quarto_render(\"notebook.Rmd\", output_format = \"pdf\") # Render Jupyter Notebook quarto_render(\"notebook.ipynb\") # Render Jupyter Markdown quarto_render(\"notebook.md\") # Override metadata quarto_render(\"notebook.Rmd\", metadata = list(lang = \"fr\", execute = list(echo = FALSE))) } # }"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_serve.html","id":null,"dir":"Reference","previous_headings":"","what":"Serve Interactive Document — quarto_serve","title":"Serve Interactive Document — quarto_serve","text":"Serve Shiny interactive document. default, document rendered first served previously rendered document, pass render = FALSE skip rendering.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_serve.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Serve Interactive Document — quarto_serve","text":"","code":"quarto_serve( input, render = TRUE, port = getOption(\"shiny.port\"), host = getOption(\"shiny.host\", \"127.0.0.1\"), browse = TRUE )"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_serve.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Serve Interactive Document — quarto_serve","text":"input input file run. file server: shiny entry YAML front-matter. render Render document serving . port Port listen (defaults 4848) host Hostname bind (defaults 127.0.0.1) browse Open browser preview content. Defaults using RStudio Viewer running within RStudio.Pass function (e.g. utils::browseURL override behavior).","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_use_template.html","id":null,"dir":"Reference","previous_headings":"","what":"Use a custom format extension template — quarto_use_template","title":"Use a custom format extension template — quarto_use_template","text":"Install use template Quarto using quarto use.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_use_template.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Use a custom format extension template — quarto_use_template","text":"","code":"quarto_use_template( template, no_prompt = FALSE, quiet = FALSE, quarto_args = NULL )"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_use_template.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Use a custom format extension template — quarto_use_template","text":"template template install, either archive GitHub repository described documentation https://quarto.org/docs/extensions/formats.html. no_prompt prompt confirm approval download external extension. quiet Suppress warnings messages. quarto_args Character vector quarto CLI arguments append Quarto command executed function. mainly intended advanced usage useful CLI arguments yet mirrored dedicated parameter R function. See quarto render --help options.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_use_template.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Use a custom format extension template — quarto_use_template","text":"","code":"if (FALSE) { # \\dontrun{ # Install a template and set up a draft document from a GitHub repository quarto_use_template(\"quarto-journals/jss\") # Install a template and set up a draft document from a ZIP archive quarto_use_template(\"https://github.com/quarto-journals/jss/archive/refs/heads/main.zip\") } # }"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_version.html","id":null,"dir":"Reference","previous_headings":"","what":"Check quarto version — quarto_version","title":"Check quarto version — quarto_version","text":"Determine specific version quarto binary found quarto_path(). returns 99.9.9 means using dev version.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_version.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check quarto version — quarto_version","text":"","code":"quarto_version()"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_version.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check quarto version — quarto_version","text":"numeric_version quarto version found","code":""},{"path":[]},{"path":"https://quarto-dev.github.io/quarto-r/news/index.html","id":"quarto-144","dir":"Changelog","previous_headings":"","what":"quarto 1.4.4","title":"quarto 1.4.4","text":"CRAN release: 2024-07-20 quarto_preview() now looks quarto preview log browse correct url inside RStudio viewer (thanks, @aronatkins, #167). package now uses x.y.z.dev versionning scheme indicate development, patch, minor major versions. follows Tidyverse package version conventions. Adapt tests CRAN checks issues due Quarto v1.5.54 regression (though fixed upstream). Approval check quarto_add_extension() quarto_use_template() now works correctly (thanks, @eveyp, #172).","code":""},{"path":"https://quarto-dev.github.io/quarto-r/news/index.html","id":"quarto-14","dir":"Changelog","previous_headings":"","what":"quarto 1.4","title":"quarto 1.4","text":"CRAN release: 2024-03-06 version now adapted Quarto 1.4 latest stable release. Add registration vignette engine use quarto vignette builder, use .qmd file vignette. See vignette(\"hello\", package = \"quarto\"). (thanks, @dcnorris, #57). New quarto_binary_sitrep() checks possible difference Quarto binary used package, one used RStudio IDE (thanks, @jthomasmock, #12). New is_using_quarto() check directory requires using Quarto (.e. _quarto.yml least one *.qmd file) (thanks, @hadley, #103). New quarto_create_project() calls quarto create project (thanks, @maelle, #87). New quarto_add_extension() quarto_use_template() deal Quarto extensions Quarto project. (thanks, @mcanouil, #45, @remlapmot, #42). quarto_render() quarto_inspect() gains profile argument (thanks, @andrewheiss, #95, @salim-b, #123). quarto_render() gains metadata metadata_file arguments. can used pass modified Quarto metadata render time. set, metadata merged metadata_file content. Internally, metadata passed --metadata-file quarto render (thanks, @mcanouil, #52, @maelle, #49). quarto_render() relevant functions gain quarto_args argument. allows pass additional options flag quarto CLI. advanced usage e.g. new options added Quarto CLI user-facing package’s functions (thanks, @gadenbuie, #125). Add quiet argument functions remove warnings messages. default FALSE function match quarto CLI default. quarto_render(), execute_params now converts boolean value true/false correctly expected quarto render (thanks, @marianklose, #124). Error message now advises re-run quiet = FALSE quarto_render(quiet = TRUE) run quarto render quiet mode (thanks @gadenbuie, #126, @wlandau, #16). rsconnect R package dependency moved Suggest reduce package’s overall number dependencies. rsconnect package required publishing using quarto_publish_*() functions. Users prompted install (interactive mode) installed. Added NEWS.md file track changes package.","code":""}] +[{"path":[]},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement codeofconduct@posit.co. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to quarto","title":"Contributing to quarto","text":"welcome contributions quarto R package. can contribute many ways: opening issues give feedback share ideas. fixing typos documentations submitting Pull Request (PR) fix opened issues submitting Pull Request (PR) suggest new features. (considered good practice open issues discuss ideas)","code":""},{"path":"https://quarto-dev.github.io/quarto-r/CONTRIBUTING.html","id":"to-submit-a-contribution-using-a-pull-request","dir":"","previous_headings":"","what":"To submit a contribution using a Pull Request:","title":"Contributing to quarto","text":"Fork repository make changes new branch specific PR. ok edit file repository using Edit button Github change simple enough. significant changes (e.g required fixing typos), ensure signed individual corporate contributor agreement appropriate. can send signed copy contribute@posit.co. Submit pull request. ok submit draft still working like feedback us. always good share open working . ’ll try responsive possible reviewing accepting pull requests. Appreciate contributions much!","code":""},{"path":"https://quarto-dev.github.io/quarto-r/articles/hello.html","id":"quarto-as-vignette-builder","dir":"Articles","previous_headings":"","what":"Quarto as vignette builder","title":"Quarto HTML Vignettes","text":"Add DESCRIPTION file:","code":"VignetteBuilder: quarto"},{"path":"https://quarto-dev.github.io/quarto-r/articles/hello.html","id":"html-vignette-engines","dir":"Articles","previous_headings":"","what":"HTML Vignette Engines","title":"Quarto HTML Vignettes","text":"quarto R package registers vignette engines can used %\\VignetteEngine{} directives vignette headers. learn vignettes engine works, write vignette engines, see Writing R Extensions manual R Packages (2e) book. produce HTML vignette engine, add YAML header build HTML document using Quarto, suitable using vignette publish CRAN. Choice made create minimal HTML vignette default, built following changes based Quarto’s format: html defaults: HTML file produced standalone (.e. embed-resources: true) Bootstrap disabled (.e. theme: none minimal: true) custom CSS file provided. equivalent configurations set way can’t overriden YAML header vignette source file new configurations can set. Typical examples configurations adding table contents enabling rendering mathematical notation format options, e.g., MathJax. Specifically, two options can set following way: minimal default format deliberate limitation current implementation vignette engine. ensures HTML vignettes produced reasonable size can published CRAN without problems. Another limitation concerns interactive rendering. render vignette .qmd file using quarto render function, output based default HTML format Quarto vignette engine one. building vignette produce real results. details building vignettes available R Packages (2e) book. Intermediates resources created authoring workflow quarto render default format: html ignored package sources. Added .Rbuildignore (e.g usethis::use_build_ignore(\"vignettes/*_files\")) Added .gitignore (e.g. usethis::use_git_ignore(\"*_files\", \"vignettes\"))","code":"vignette: > %\\VignetteIndexEntry{Vignette's Title} %\\VignetteEngine{quarto::html} %\\VignetteEncoding{UTF-8} --- format: html: theme: none minimal: true embed-resources: true css: custom.css format: html: toc: true html-math-method: mathjax vignette: > %\\VignetteIndexEntry{Vignette's Title} %\\VignetteEngine{quarto::html} %\\VignetteEncoding{UTF-8}"},{"path":"https://quarto-dev.github.io/quarto-r/articles/publishing.html","id":"overview","dir":"Articles","previous_headings":"","what":"Overview","title":"Publishing","text":"quarto package includes several functions enable publish static interactive documents, websites, books Posit Connect shinyapps.io. publishing Posit Connect, simple content publishing (local rendering) well code publishing (rendering Connect) supported.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/articles/publishing.html","id":"accounts","dir":"Articles","previous_headings":"","what":"Accounts","title":"Publishing","text":"publishing Posit Connect shinyapps.io ensure account configured publishing. Posit Connect, use rsconnect::connectUser() function server publishing . example: ’ll prompted authoring account web browser. shinyapps.io, use rsconnect::setAccountInfo() function. example: Note can copy paste code Tokens page shinyapps.io admin panel.","code":"rsconnect::connectUser(server = \"rsc.example.com\") rsconnect::setAccountInfo(name = 'norahjones', token = 'AB6783FD23', secret = '36x+k0bBy6W')"},{"path":"https://quarto-dev.github.io/quarto-r/articles/publishing.html","id":"documents","dir":"Articles","previous_headings":"","what":"Documents","title":"Publishing","text":"Use quarto_publish_doc() function publish single document Posit Connect. Note first time publish specify server account want use publishing. example: Subsequent updates document don’t need specify server account: example renders content locally publishes just content server. can also render server (uploading source code required render). might want order create scheduled versions report update automatically underlying data changes. , add render = \"server\" argument:","code":"library(quarto) quarto_publish_doc(\"document.qmd\", server = \"rsc.example.com\", account = \"njones\") quarto_publish_doc(\"document.qmd\") quarto_publish_doc(\"document.qmd\", server = \"rsc.example.com\", account = \"njones\", render = \"server\")"},{"path":"https://quarto-dev.github.io/quarto-r/articles/publishing.html","id":"websites","dir":"Articles","previous_headings":"","what":"Websites","title":"Publishing","text":"Use quarto_publish_site() function publish website book Posit Connect. Note first time publish specify server account want use publishing. example: Subsequent updates site don’t need specify server account: example renders content locally publishes just content server. can also render server (uploading source code required render). might want order create scheduled versions website update automatically underlying data changes. , add render = \"server\" argument:","code":"library(quarto) quarto_publish_site(server = \"rsc.example.com\", account = \"njones\") quarto_publish_site() quarto_publish_site(server = \"rsc.example.com\", account = \"njones\", render = \"server\")"},{"path":"https://quarto-dev.github.io/quarto-r/articles/publishing.html","id":"interactive-docs","dir":"Articles","previous_headings":"","what":"Interactive Docs","title":"Publishing","text":"can publish Shiny interactive documents either Posit Connect shinyapps.io. publish Posit Connect, specify server account want use publishing (required first publish ). example: publish shinyapps.io, use server = \"shinyapps.io\": services, subsequent publishes need provide server account:","code":"library(quarto) quarto_publish_app(\"shiny.qmd\", server = \"rsc.example.com\", account = \"njones\") quarto_publish_app(\"shiny.qmd\", server = \"shinyapps.io\") quarto_publish_app(\"shiny.qmd\")"},{"path":"https://quarto-dev.github.io/quarto-r/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"JJ Allaire. Author. Christophe Dervieux. Maintainer, author. Posit Software, PBC. Copyright holder, funder.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Allaire J, Dervieux C (2024). quarto: R Interface 'Quarto' Markdown Publishing System. R package version 1.4.4.9001, https://quarto-dev.github.io/quarto-r/, https://github.com/quarto-dev/quarto-r.","code":"@Manual{, title = {quarto: R Interface to 'Quarto' Markdown Publishing System}, author = {JJ Allaire and Christophe Dervieux}, year = {2024}, note = {R package version 1.4.4.9001, https://quarto-dev.github.io/quarto-r/}, url = {https://github.com/quarto-dev/quarto-r}, }"},{"path":"https://quarto-dev.github.io/quarto-r/index.html","id":"quarto-","dir":"","previous_headings":"","what":"R Interface to Quarto Markdown Publishing System","title":"R Interface to Quarto Markdown Publishing System","text":"Quarto open-source scientific technical publishing system built Pandoc. quarto package provides R interface frequently used operations Quarto Command Line Interface (CLI). package requirement using Quarto R. Rather, provides R interface common Quarto operations users prefer work R console rather terminal, package authors want interface Quarto using scripts. using Quarto R package, install Quarto CLI https://quarto.org/docs/get-started/.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/index.html","id":"installing-the-package","dir":"","previous_headings":"","what":"Installing the package","title":"R Interface to Quarto Markdown Publishing System","text":"Latest released version CRAN Latest dev version Github Latest build dev version r-universe Look Functions Reference page see list functions available package.","code":"# latest release version install.packages(\"quarto\") # dev version pak::pak(\"quarto-dev/quarto-r\") # or remotes::install_github(\"quarto-dev/quarto-r\") install.packages('quarto', repos = c('https://quarto-dev.r-universe.dev', 'https://cloud.r-project.org'))"},{"path":"https://quarto-dev.github.io/quarto-r/reference/is_using_quarto.html","id":null,"dir":"Reference","previous_headings":"","what":"Check is a directory is using quarto — is_using_quarto","title":"Check is a directory is using quarto — is_using_quarto","text":"function check directory using quarto looking _quarto.yml root least one .qmd file directory","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/is_using_quarto.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check is a directory is using quarto — is_using_quarto","text":"","code":"is_using_quarto(dir = \".\", verbose = FALSE)"},{"path":"https://quarto-dev.github.io/quarto-r/reference/is_using_quarto.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check is a directory is using quarto — is_using_quarto","text":"dir directory check verbose print message result check","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/is_using_quarto.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check is a directory is using quarto — is_using_quarto","text":"","code":"dir.create(tmpdir <- tempfile()) is_using_quarto(tmpdir) #> [1] FALSE file.create(file.path(tmpdir, \"_quarto.yml\")) #> [1] TRUE is_using_quarto(tmpdir) #> [1] TRUE unlink(tmpdir, recursive = TRUE)"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto-package.html","id":null,"dir":"Reference","previous_headings":"","what":"quarto: R Interface to 'Quarto' Markdown Publishing System — quarto-package","title":"quarto: R Interface to 'Quarto' Markdown Publishing System — quarto-package","text":"Convert R Markdown documents 'Jupyter' notebooks variety output formats using 'Quarto'.","code":""},{"path":[]},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"quarto: R Interface to 'Quarto' Markdown Publishing System — quarto-package","text":"Maintainer: Christophe Dervieux cderv@posit.co (ORCID) Authors: JJ Allaire jj@posit.co (ORCID) contributors: Posit Software, PBC [copyright holder, funder]","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_add_extension.html","id":null,"dir":"Reference","previous_headings":"","what":"Install a Quarto extensions — quarto_add_extension","title":"Install a Quarto extensions — quarto_add_extension","text":"Add extension folder project running quarto add","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_add_extension.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Install a Quarto extensions — quarto_add_extension","text":"","code":"quarto_add_extension( extension = NULL, no_prompt = FALSE, quiet = FALSE, quarto_args = NULL )"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_add_extension.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Install a Quarto extensions — quarto_add_extension","text":"extension extension install, either archive GitHub repository described documentation https://quarto.org/docs/extensions/managing.html. no_prompt prompt confirm approval download external extension. quiet Suppress warning messages. quarto_args Character vector quarto CLI arguments append Quarto command executed function. mainly intended advanced usage useful CLI arguments yet mirrored dedicated parameter R function. See quarto render --help options.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_add_extension.html","id":"extension-trust","dir":"Reference","previous_headings":"","what":"Extension Trust","title":"Install a Quarto extensions — quarto_add_extension","text":"Quarto extensions may execute code documents rendered. Therefore, trust author extension, recommend install use extension. default no_prompt = FALSE means function ask explicit approval used interactively, disallow installation.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_add_extension.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Install a Quarto extensions — quarto_add_extension","text":"","code":"if (FALSE) { # \\dontrun{ # Install a template and set up a draft document from a GitHub repository quarto_add_extension(\"quarto-ext/fontawesome\") # Install a template and set up a draft document from a ZIP archive quarto_add_extension(\"https://github.com/quarto-ext/fontawesome/archive/refs/heads/main.zip\") } # }"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_binary_sitrep.html","id":null,"dir":"Reference","previous_headings":"","what":"Check configurations for quarto binary used — quarto_binary_sitrep","title":"Check configurations for quarto binary used — quarto_binary_sitrep","text":"function check configuration quarto package R package detect possible difference version used RStudio IDE.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_binary_sitrep.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check configurations for quarto binary used — quarto_binary_sitrep","text":"","code":"quarto_binary_sitrep(verbose = TRUE, debug = FALSE)"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_binary_sitrep.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check configurations for quarto binary used — quarto_binary_sitrep","text":"verbose FALSE, return result check. debug TRUE, print information value set configurations.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_binary_sitrep.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check configurations for quarto binary used — quarto_binary_sitrep","text":"TRUE package using quarto binary RStudio IDE. FALSE otherwise difference detected quarto found. Use verbose = TRUE ordebug = TRUE get detailed information.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_binary_sitrep.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check configurations for quarto binary used — quarto_binary_sitrep","text":"","code":"quarto_binary_sitrep(verbose = FALSE) #> [1] TRUE quarto_binary_sitrep(verbose = TRUE) #> ✔ quarto R package will use /opt/quarto/bin/quarto #> [1] TRUE quarto_binary_sitrep(debug = TRUE) #> ✔ quarto R package will use /opt/quarto/bin/quarto #> ℹ It is configured to use the latest version found in the PATH environment variable. #> [1] TRUE"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_create_project.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a quarto project — quarto_create_project","title":"Create a quarto project — quarto_create_project","text":"function calls quarto create project . create new directory project name add skeletons files project type chosen.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_create_project.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a quarto project — quarto_create_project","text":"","code":"quarto_create_project( name, type = \"default\", dir = \".\", no_prompt = FALSE, quiet = FALSE, quarto_args = NULL )"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_create_project.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a quarto project — quarto_create_project","text":"name name project directory created. type type project create. 1.4, can one default, website, blog, book, manuscript, confluence. dir directory create new Quarto project. no_prompt prompt confirm approval download external extension. quiet Suppress warning messages. quarto_args Character vector quarto CLI arguments append Quarto command executed function. mainly intended advanced usage useful CLI arguments yet mirrored dedicated parameter R function. See quarto render --help options.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_create_project.html","id":"quarto-version-required","dir":"Reference","previous_headings":"","what":"Quarto version required","title":"Create a quarto project — quarto_create_project","text":"function require Quarto 1.4 higher. Use quarto_version()check version Quarto detected.","code":""},{"path":[]},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_inspect.html","id":null,"dir":"Reference","previous_headings":"","what":"Inspect Quarto Input File or Project — quarto_inspect","title":"Inspect Quarto Input File or Project — quarto_inspect","text":"Inspect Quarto project input path. Inspecting project returns config engines. Inspecting input path return formats, engine, dependent resources.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_inspect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Inspect Quarto Input File or Project — quarto_inspect","text":"","code":"quarto_inspect(input = \".\", profile = NULL, quiet = FALSE, quarto_args = NULL)"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_inspect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Inspect Quarto Input File or Project — quarto_inspect","text":"input input file project directory inspect. profile Quarto project profile(s) use. Either character vector profile names NULL use default profile. quiet Suppress warning messages. quarto_args Character vector quarto CLI arguments append Quarto command executed function. mainly intended advanced usage useful CLI arguments yet mirrored dedicated parameter R function. See quarto render --help options.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_inspect.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Inspect Quarto Input File or Project — quarto_inspect","text":"Named list. input files, list contains elements quarto, engines, formats, resources, plus project file part Quarto project. projects, list contains elements quarto, dir, engines, config files.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_inspect.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Inspect Quarto Input File or Project — quarto_inspect","text":"","code":"if (FALSE) { # \\dontrun{ # Inspect input file file quarto_inspect(\"notebook.Rmd\") # Inspect project quarto_inspect(\"myproject\") # Inspect project's advanced profile quarto_inspect( input = \"myproject\", profile = \"advanced\" ) } # }"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_path.html","id":null,"dir":"Reference","previous_headings":"","what":"Path to the quarto binary — quarto_path","title":"Path to the quarto binary — quarto_path","text":"Determine path quarto binary. Uses QUARTO_PATH environment variable defined, otherwise uses Sys.().","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_path.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Path to the quarto binary — quarto_path","text":"","code":"quarto_path()"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_path.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Path to the quarto binary — quarto_path","text":"Path quarto binary (NULL found)","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_preview.html","id":null,"dir":"Reference","previous_headings":"","what":"Quarto Preview — quarto_preview","title":"Quarto Preview — quarto_preview","text":"Render preview Quarto document website project.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_preview.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Quarto Preview — quarto_preview","text":"","code":"quarto_preview( file = NULL, render = \"auto\", port = \"auto\", host = \"127.0.0.1\", browse = TRUE, watch = TRUE, navigate = TRUE ) quarto_preview_stop()"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_preview.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Quarto Preview — quarto_preview","text":"file document website project directory preview (defaults current working directory) render website preview, recent execution results computational documents used render site (optimize startup time). want perform full render prior serving pass \"\" vector specific formats render. Pass \"default\" render default format site. document preview, document rendered prior preview (pass FALSE override ). port Port listen (defaults 4848) host Hostname bind (defaults 127.0.0.1) browse Open browser preview content. Defaults using RStudio Viewer running within RStudio.Pass function (e.g. utils::browseURL override behavior). watch Watch changes automatically reload browser. navigate Automatically navigate preview browser recently rendered document.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_preview.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Quarto Preview — quarto_preview","text":"Automatically reloads browser input files re-rendered document resources (e.g. CSS) change.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_preview.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Quarto Preview — quarto_preview","text":"","code":"if (FALSE) { # \\dontrun{ # Preview the project in the current directory quarto_preview() # Preview a document quarto_preview(\"document.qmd\") # Preview the project in \"myproj\" directory and use external browser # (rather than RStudio Viewer) quarto_preview(\"myproj\", open = utils::browseURL) # Stop any running quarto preview quarto_preview_stop() } # }"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_publish_doc.html","id":null,"dir":"Reference","previous_headings":"","what":"Publish Quarto Documents — quarto_publish_doc","title":"Publish Quarto Documents — quarto_publish_doc","text":"Publish Quarto documents Posit Connect, ShinyApps, RPubs","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_publish_doc.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Publish Quarto Documents — quarto_publish_doc","text":"","code":"quarto_publish_doc( input, name = NULL, title = NULL, server = NULL, account = NULL, render = c(\"local\", \"server\", \"none\"), metadata = list(), ... ) quarto_publish_app( input = getwd(), name = NULL, title = NULL, server = NULL, account = NULL, render = c(\"local\", \"server\", \"none\"), metadata = list(), ... ) quarto_publish_site( input = getwd(), name = NULL, title = NULL, server = NULL, account = NULL, render = c(\"local\", \"server\", \"none\"), metadata = list(), ... )"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_publish_doc.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Publish Quarto Documents — quarto_publish_doc","text":"input input file project directory published. Defaults current working directory. name Name publishing (names must unique within account). Defaults name input. title Free-form descriptive title application. Optional; supplied, often displayed favor name. deploying new document, may supply title receive auto-generated name account, server Uniquely identify remote server either user account, server name, . neither supplied, multiple options, prompted pick one. Use accounts() see full list available options. render local render locally publishing; server render server; none use whatever rendered content currently exists locally. (defaults local) metadata Additional metadata fields save deployment record. fields returned subsequent calls deployments(). Multi-value fields recorded comma-separated values returned form. Custom value serialization responsibility caller. ... Named parameters pass along rsconnect::deployApp()","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_publish_doc.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Publish Quarto Documents — quarto_publish_doc","text":"","code":"if (FALSE) { # \\dontrun{ library(quarto) quarto_publish_doc(\"mydoc.qmd\") quarto_publish_app(server = \"shinyapps.io\") quarto_publish_site(server = \"rstudioconnect.example.com\") } # }"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_render.html","id":null,"dir":"Reference","previous_headings":"","what":"Render Markdown — quarto_render","title":"Render Markdown — quarto_render","text":"Render input file specified output format using quarto. input requires computations (e.g. Rmd Jupyter files) computations performed rendering.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_render.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Render Markdown — quarto_render","text":"","code":"quarto_render( input = NULL, output_format = NULL, output_file = NULL, execute = TRUE, execute_params = NULL, execute_dir = NULL, execute_daemon = NULL, execute_daemon_restart = FALSE, execute_debug = FALSE, use_freezer = FALSE, cache = NULL, cache_refresh = FALSE, metadata = NULL, metadata_file = NULL, debug = FALSE, quiet = FALSE, profile = NULL, quarto_args = NULL, pandoc_args = NULL, as_job = getOption(\"quarto.render_as_job\", \"auto\") )"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_render.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Render Markdown — quarto_render","text":"input input file project directory rendered (defaults rendering project current working directory). output_format Target output format (defaults \"html\"). option \"\" render formats defined within file project. output_file name output file. using NULL, output filename based filename input file. output_file mapped --output option flag quarto CLI. expected filename , path, relative absolute. execute Whether execute embedded code chunks. execute_params list named parameters override custom params specified within YAML front-matter. execute_dir working directory execute embedded code chunks. execute_daemon Keep Jupyter kernel alive (defaults 300 seconds). Note option applicable rendering Jupyter notebooks Jupyter markdown. execute_daemon_restart Restart keepalive Jupyter kernel render. Note option applicable rendering Jupyter notebooks Jupyter markdown. execute_debug Show debug output Jupyter kernel. use_freezer Force use frozen computations incremental file render. cache Cache execution output (uses knitr cache jupyter-cache respectively Rmd Jupyter input files). cache_refresh Force refresh execution cache. metadata optional named list used override YAML metadata. passed YAML file --metadata-file CLI flag. merged metadata-file options specified. metadata_file yaml file passed --metadata-file CLI flags override metadata. merged metadata specified, low precedence metadata options. debug Leave intermediate files place render. quiet Suppress warning messages. profile Quarto project profile(s) use. Either character vector profile names NULL use default profile. quarto_args Character vector quarto CLI arguments append Quarto command executed function. mainly intended advanced usage useful CLI arguments yet mirrored dedicated parameter R function. See quarto render --help options. pandoc_args Additional command line arguments pass Pandoc. as_job Render RStudio background job. Default \"auto\", render individual documents normally projects background jobs. Use quarto.render_as_job R option control default globally.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_render.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Render Markdown — quarto_render","text":"","code":"if (FALSE) { # \\dontrun{ # Render R Markdown quarto_render(\"notebook.Rmd\") quarto_render(\"notebook.Rmd\", output_format = \"pdf\") # Render Jupyter Notebook quarto_render(\"notebook.ipynb\") # Render Jupyter Markdown quarto_render(\"notebook.md\") # Override metadata quarto_render(\"notebook.Rmd\", metadata = list(lang = \"fr\", execute = list(echo = FALSE))) } # }"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_serve.html","id":null,"dir":"Reference","previous_headings":"","what":"Serve Interactive Document — quarto_serve","title":"Serve Interactive Document — quarto_serve","text":"Serve Shiny interactive document. default, document rendered first served previously rendered document, pass render = FALSE skip rendering.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_serve.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Serve Interactive Document — quarto_serve","text":"","code":"quarto_serve( input, render = TRUE, port = getOption(\"shiny.port\"), host = getOption(\"shiny.host\", \"127.0.0.1\"), browse = TRUE )"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_serve.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Serve Interactive Document — quarto_serve","text":"input input file run. file server: shiny entry YAML front-matter. render Render document serving . port Port listen (defaults 4848) host Hostname bind (defaults 127.0.0.1) browse Open browser preview content. Defaults using RStudio Viewer running within RStudio.Pass function (e.g. utils::browseURL override behavior).","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_use_template.html","id":null,"dir":"Reference","previous_headings":"","what":"Use a custom format extension template — quarto_use_template","title":"Use a custom format extension template — quarto_use_template","text":"Install use template Quarto using quarto use.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_use_template.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Use a custom format extension template — quarto_use_template","text":"","code":"quarto_use_template( template, no_prompt = FALSE, quiet = FALSE, quarto_args = NULL )"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_use_template.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Use a custom format extension template — quarto_use_template","text":"template template install, either archive GitHub repository described documentation https://quarto.org/docs/extensions/formats.html. no_prompt prompt confirm approval download external extension. quiet Suppress warnings messages. quarto_args Character vector quarto CLI arguments append Quarto command executed function. mainly intended advanced usage useful CLI arguments yet mirrored dedicated parameter R function. See quarto render --help options.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_use_template.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Use a custom format extension template — quarto_use_template","text":"","code":"if (FALSE) { # \\dontrun{ # Install a template and set up a draft document from a GitHub repository quarto_use_template(\"quarto-journals/jss\") # Install a template and set up a draft document from a ZIP archive quarto_use_template(\"https://github.com/quarto-journals/jss/archive/refs/heads/main.zip\") } # }"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_version.html","id":null,"dir":"Reference","previous_headings":"","what":"Check quarto version — quarto_version","title":"Check quarto version — quarto_version","text":"Determine specific version quarto binary found quarto_path(). returns 99.9.9 means using dev version.","code":""},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_version.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check quarto version — quarto_version","text":"","code":"quarto_version()"},{"path":"https://quarto-dev.github.io/quarto-r/reference/quarto_version.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check quarto version — quarto_version","text":"numeric_version quarto version found","code":""},{"path":"https://quarto-dev.github.io/quarto-r/news/index.html","id":"quarto-development-version","dir":"Changelog","previous_headings":"","what":"quarto (development version)","title":"quarto (development version)","text":"Add quarto.quiet options allow verbose error message quarto_* function used inside package. example, inside pkgdown building Quarto vignettes. pkgdown sets quiet = TRUE internally call quarto_render(), setting options(quarto.quiet = TRUE) allows overwrite .","code":""},{"path":"https://quarto-dev.github.io/quarto-r/news/index.html","id":"quarto-144","dir":"Changelog","previous_headings":"","what":"quarto 1.4.4","title":"quarto 1.4.4","text":"CRAN release: 2024-07-20 quarto_preview() now looks quarto preview log browse correct url inside RStudio viewer (thanks, @aronatkins, #167). package now uses x.y.z.dev versionning scheme indicate development, patch, minor major versions. follows Tidyverse package version conventions. Adapt tests CRAN checks issues due Quarto v1.5.54 regression (though fixed upstream). Approval check quarto_add_extension() quarto_use_template() now works correctly (thanks, @eveyp, #172).","code":""},{"path":"https://quarto-dev.github.io/quarto-r/news/index.html","id":"quarto-14","dir":"Changelog","previous_headings":"","what":"quarto 1.4","title":"quarto 1.4","text":"CRAN release: 2024-03-06 version now adapted Quarto 1.4 latest stable release. Add registration vignette engine use quarto vignette builder, use .qmd file vignette. See vignette(\"hello\", package = \"quarto\"). (thanks, @dcnorris, #57). New quarto_binary_sitrep() checks possible difference Quarto binary used package, one used RStudio IDE (thanks, @jthomasmock, #12). New is_using_quarto() check directory requires using Quarto (.e. _quarto.yml least one *.qmd file) (thanks, @hadley, #103). New quarto_create_project() calls quarto create project (thanks, @maelle, #87). New quarto_add_extension() quarto_use_template() deal Quarto extensions Quarto project. (thanks, @mcanouil, #45, @remlapmot, #42). quarto_render() quarto_inspect() gains profile argument (thanks, @andrewheiss, #95, @salim-b, #123). quarto_render() gains metadata metadata_file arguments. can used pass modified Quarto metadata render time. set, metadata merged metadata_file content. Internally, metadata passed --metadata-file quarto render (thanks, @mcanouil, #52, @maelle, #49). quarto_render() relevant functions gain quarto_args argument. allows pass additional options flag quarto CLI. advanced usage e.g. new options added Quarto CLI user-facing package’s functions (thanks, @gadenbuie, #125). Add quiet argument functions remove warnings messages. default FALSE function match quarto CLI default. quarto_render(), execute_params now converts boolean value true/false correctly expected quarto render (thanks, @marianklose, #124). Error message now advises re-run quiet = FALSE quarto_render(quiet = TRUE) run quarto render quiet mode (thanks @gadenbuie, #126, @wlandau, #16). rsconnect R package dependency moved Suggest reduce package’s overall number dependencies. rsconnect package required publishing using quarto_publish_*() functions. Users prompted install (interactive mode) installed. Added NEWS.md file track changes package.","code":""}]
Allaire J, Dervieux C (2024). quarto: R Interface to 'Quarto' Markdown Publishing System. -R package version 1.4.4.9000, +R package version 1.4.4.9001, https://quarto-dev.github.io/quarto-r/, https://github.com/quarto-dev/quarto-r.
@Manual{, title = {quarto: R Interface to 'Quarto' Markdown Publishing System}, author = {JJ Allaire and Christophe Dervieux}, year = {2024}, - note = {R package version 1.4.4.9000, + note = {R package version 1.4.4.9001, https://quarto-dev.github.io/quarto-r/}, url = {https://github.com/quarto-dev/quarto-r}, }
quarto.quiet
quarto_*
quiet = TRUE
quarto_render()
options(quarto.quiet = TRUE)
CRAN release: 2024-07-20
quarto_preview() now looks at quarto preview log to browse to the correct url when inside RStudio viewer (thanks, @aronatkins, #167).
quarto_preview()
quarto preview