App-packages

Expand the callout boxes below to review what we’ve covered in the last four chapters:

Review Chapters 1 - 4

Whole app game (Chapter 1)

1  Whole app game walks through the ‘whole game’ of the app-package development workflow. The application in this example comes from the Packages chapter of Mastering Shiny.

• 1.2 Package metadata
• 1.3 Data
• 1.4 Dependencies
• 1.5 Package code
• 1.6 Loading
  
• 1.7 Package tests
  
• 1.8 app.R
  • 1.8.1 use_package_doc()
  • 1.8.2 use_build_ignore()
• 1.9 LICENSE
• 1.10 Document
  • 1.10.1 Namespace
• 1.11 RStudio project options
• 1.12 Git
• 1.13 Keyboard shortcuts
• 1.14 Install
• 1.15 Additional files
  • 1.15.1 README
  • 1.15.2 NEWS.md
  • 1.15.3 Vignettes

Shiny (Chapter 2)

The Shiny chapter covers:

• 2.1 Shiny projects
• 2.3 Folders
• 2.4 Files
  • 2.5.1 Modules
  • 2.5.2 Standalone app function
• 2.6 Additional features

Packages (Chapter 3)

Packages illustrates what separates R projects from R packages:

• 3.1 R packages
  • 3.1.1 Essential ingredients
  • 3.1.2 RStudio’s Build pane
  • 3.1.3 Positron’s workspaces
• 3.2 App-packages
  • 3.2.1 New app-packages
  • 3.2.2 Converting a Shiny project

Development (Chapter 4)

4  Development introduced the devtools package and its core functions:

1. 4.2 Load
2. 4.3 Document and
3. 4.4 Install

App-packages

In the following chapters, we will continue developing our Shiny application within the R package structure. Below is a preview of each topic covered in the upcoming chapters.

Documentation (Chapter 5)

5  Documentation covers documenting the code in your app-package with roxygen2:

• Required tags:
  • 5.1.2 Markdown support
  • 5.1.3 Title & description
  • 5.1.4 Parameters & return objects and
  • 5.1.6 Examples
• App-package tags for modules and standalone app functions:
  • 5.2.1 See also
    
  • 5.2.2 Family
    
  • 5.3.1 Usage, and
    
  • 5.2.3 Section

Dependencies (Chapter 6)

6  Dependencies dives into the external (i.e. add-on) functions and packages you’ve used to build your app-package. We’ll also cover how to export functions and objects from your app-packages for others to use.

• 6.1 Package exports
  
• 6.2 Package imports

Data (Chapter 7)

7  Data covers how to include datasets in your app-package namespace, and the various kinds of data in R packages.

• Storing and Documenting data:
  • 7.1 The data/ folder
  • 7.3 Documenting data
    
• Raw data files:
  • 7.2 data-raw/
    
• Other locations for data:
  • 7.4 External data

Launch (Chapter 8)

The 8  Launch chapter covers how to 1) run your application during development, 2) how to run your app using a standalone app function, and 3) how to deploy your application to shinyapps.io.

• App run functions:
  • 8.2.1 shinyApp()
  • 8.2.2 shinyAppDir()
  • 8.2.3 runApp()
• Launching app files:
  • 8.4 The app.R file

Resources (Chapter 9)

9  Resources covers how to include external resources (i.e. the images, CSS, html, or other files that are typically included in the www/ folder and served when you run your Shiny app). This chapter also covers other uses for the isnt/ folder in app-packages.

• Static files:
  • 9.1 Image files
    
  • 9.1.2 addResourcePath()
    
• Data files:
  • 9.2.1 A tidy-movies app
    
• Quarto apps:
  • 9.3 Quarto apps
    
• Production:
  • 9.4 Production

See a typo, error, or something missing?

Please open an issue on GitHub