Skip to content

Latest commit

 

History

History
49 lines (42 loc) · 3.38 KB

TODO.md

File metadata and controls

49 lines (42 loc) · 3.38 KB

TODO

Inspired by renv's historical TODO.md

Content

  • Add R Setup notebook
  • Add problems and solutions to the training log, including how to get around the limitation that you can't debug R Notebooks. (considered and rejected the knitr-spin.R approach)
  • Add notes on resolving the error message generated by use_package("tidyverse")
  • Update README.Rmd
  • Add notes from https://r-pkgs.org
  • Convert R Setup notebook to a vignette
  • Update setup notes with current configuration using rig

Package

  • Write wrapper functions to styler and lintr all files: the package, README.Rmd, and notebooks directory
  • Write a utility/maintenance function to verify: renv::status, renv::clean, and possibly renv::update - see https://github.com/rstudio/renv/blob/master/R/status.R
  • Write a utility function to sort .Rbuildignore
  • Migrate utility functions to rdev
  • Integrate build-site and pkgdown using custom navbars
    • Implement pkgdown
    • Rename notebooks/ to analysis/, build-site in a subdirectory (docs/analysis)
  • Refactor site builder as an R function
    • wrapper for rmarkdown::render_site()
    • run the build in a temporary directory like render_site()
    • re-use code from render_site() to create list of R Notebooks
    • dynamically build the _site.yml file using yaml with configuration settings passed to the wrapper function
    • dynamically build the index.Rmd using DESCRIPTION
    • support for additional links in the navbar
    • order links by Title, not filename
    • better logic for converting html_notebook to html_document
  • Migrate site builder to rdev
  • Review https://github.com/rstudio/renv/ for ideas to include here
  • Review bslib, pkgdown documentation, and bootswatch themes to determine new site look and feel
  • Evaluate converting from notebooks to a Quarto website
  • Review https://github.com/jimbrig/rtraining/ for ideas to include here

GitHub