fetch_vars: Fetch Variable Information from an SQLite Database

View source: R/access_db.R

fetch_varsR Documentation

Fetch Variable Information from an SQLite Database

Description

Displays information on the available variables in the SQLite database (data/geelite.db).

Usage

fetch_vars(
  path,
  format = c("data.frame", "markdown", "latex", "html", "pipe", "simple", "rst")
)

Arguments

path

[mandatory] (character) Path to the root directory of the generated database.

format

[mandatory] (character) A character string. Possible values are "data.frame" (default) to return a data.frame object, or one of "markdown", "latex", "html", "pipe" (Pandoc's pipe tables), "simple" (Pandoc's simple tables), and "rst" to be passed on to knitr for formatting.

Value

Returns the variable information in the selected format. If format = "data.frame", a data.frame is returned. For other formats, the output is printed in the specified format and NULL is

Examples

# Example: Printing the available variables
## Not run: 
  fetch_vars(path = "path/to/db")

## End(Not run)

geeLite documentation built on Aug. 9, 2025, 1:08 a.m.