TODO.md
In salim-b/pkgpurl: Facilitate Authoring R Packages in the R Markdown File Format

TODOs

Fix annoying "lazy-load database is corrupt" error after pkgpurl::process_pkg(use_rstudio_api = TRUE)!

The error reads something along:

Error in mget(objectNames, envir = namespace, inherits = TRUE) : lazy-load database 'PATH/TO/PKG.rdb' is corrupt In addition: Warning message: In mget(objectNames, envir = namespace, inherits = TRUE) : internal error 1 in R_decompress1 with libdeflate

There's a SO question about exactly this issue.
Add .qmd support
Write an additional line with # fmt: skip file to the *.gen.R files instructing air to ignore them. Make this optional?
Mention RStudio-Add-In splitChunk and file a bug report for native RStudio support for this functionality (the add-in has a few issues; e.g. splits in the wrong source pane when invoked from command palette and the active source pane is not primary one)
Check out
- https://rtask.thinkr.fr/when-development-starts-with-documentation/
- pkg fusen
Advertise package at relevant places
- https://github.com/rstudio/rstudio/issues/5809
Propose a standard way to render a package's main Rmd/*.Rmd source file for the pkgdown site (as an article, or better as main menu item), so people can view all Markdown annotations etc. accompanying the code ("literate programming") in the most readable way? Contra: Benefit compared to the rendered GitLab view would be minimal (currently mainly R code syntax highlighting).

Basically, we'd need to add a vignette vignettes/source_code.Rmd with the following content:

```` rmd

title: "R Markdown source code" output: rmarkdown::html_vignette vignette: > %\VignetteIndexEntry{R Markdown source code} %\VignetteEngine{knitr::rmarkdown} %\VignetteEncoding{UTF-8}

{r, child = "../Rmd/pkgpurl.Rmd", results = "hide"} ````

What's left to do would be
1. Differentiate between actual source code blocks (starting with ```{r}) and code blocks in accompanying documentation!
2. Tweak the CSS to reduce the font size of source code blocks.
3. Tweak the CSS to extend width to the right for source code blocks.