• Introduction
  • 1 Roxygen documentation guidelines
    • 1.1 General guidelines and documentation workflow
    • 1.2 Content organization
      • 1.2.1 Note about @title
    • 1.3 Advanced usage and consistent documentation
      • 1.3.1 Roxygen templates and example scripts
      • 1.3.2 Using @rdname and @describeIn
    • 1.4 Examples
      • 1.4.1 General content organization
      • 1.4.2 Templates and example scripts
      • 1.4.3 @rdname
      • 1.4.4 @describeIn
  • 2 Version-stable R development with Docker
    • 2.1 Version-stable deployments
    • 2.2 Align local development and deployment environments
      • 2.2.1 Running versioned RStudio instances
      • 2.2.2 Using podman instead of docker
      • 2.2.3 Best-supported R versions
      • 2.2.4 Cleanup
    • 2.3 References
  • 3 Control dependencies with renv
    • 3.1 Install renv
    • 3.2 Set-up an renv project
      • 3.2.1 Development dependencies
      • 3.2.2 Control package versions
    • 3.3 Removing the renv setup from a project
  • 4 CI/CD pipelines for automatic deployment of a R Shiny web app
    • 4.1 Generic CI/CD pipeline
    • 4.2 GitHub Actions
      • 4.2.1 Workflow steps
      • 4.2.2 Workflow file
      • 4.2.3 Complete workflows and usethis::use_github_action()
    • 4.3 Travis CI
      • 4.3.1 Standard CI setup
      • 4.3.2 Using renv for your project
      • 4.3.3 Automated deployment
      • 4.3.4 Putting it all together
    • 4.4 Deploying a packaged shiny application
      • 4.4.1 Entry point
      • 4.4.2 server and ui
      • 4.4.3 non-CRAN dependencies
  • 5 XLConnect: easy and controlled interface to Microsoft Excel
    • 5.1 Installation
    • 5.2 Basic functions: write & read an Excel sheet
      • 5.2.1 Writing Excel files
      • 5.2.2 Reading from Excel files
    • 5.3 Formatting
      • 5.3.1 Create and apply some formatting
      • 5.3.2 Retrieve and apply some formatting
    • 5.4 Add a graph
    • 5.5 Other functionalities
      • 5.5.1 Recalculate workbook
      • 5.5.2 Hide sheets
      • 5.5.3 Sheet visibility check and unhide sheets
      • 5.5.4 Append named region
      • 5.5.5 Remove sheets
      • 5.5.6 Remove named regions
      • 5.5.7 Clone sheets
      • 5.5.8 Clear sheets
      • 5.5.9 Add hyperlinks
      • 5.5.10 Merge / Unmerge cells
      • 5.5.11 Clean up

Technical Guidelines

2.3 References

  • The Rocker Project
  • Shared Volumes
  • Rocker Wiki
  • Sharing files with host machine
  • Rocker reference for verse and other images (in particular how to use)