quarto_inspect: Inspect Quarto Input File or Project

View source: R/inspect.R

quarto_inspectR Documentation

Inspect Quarto Input File or Project

Description

Inspect a Quarto project or input path. Inspecting a project returns its config and engines. Inspecting an input path return its formats, engine, and dependent resources.

Usage

quarto_inspect(input = ".", profile = NULL, quiet = FALSE, quarto_args = NULL)

Arguments

input

The input file or project directory to inspect.

profile

Quarto project profile(s) to use. Either a character vector of profile names or NULL to use the default profile.

quiet

Suppress warning and other messages.

quarto_args

Character vector of other quarto CLI flag pass to the command. This is mainly for advanced usage, e.g it can be useful for new options added to quarto CLI and not yet supported as function argument.

Value

Named list. For input files, the list contains the elements quarto, engines, formats, resources, plus project if the file is part of a Quarto project. For projects, the list contains the elements quarto, dir, engines, config and files.

Examples

## Not run: 
# Inspect input file file
quarto_inspect("notebook.Rmd")

# Inspect project
quarto_inspect("myproject")

# Inspect project's advanced profile
quarto_inspect(
  input = "myproject",
  profile = "advanced"
)

## End(Not run)

quarto documentation built on May 29, 2024, 5:31 a.m.