Merge pull request #57 from imperialCHEPI/confidence

Convert roxygen2 comments to markdown

DESCRIPTION

@@ -26,3 +26,4 @@ Suggests:
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
 URL: https://imperialchepi.github.io/healthgpsrvis/
+Roxygen: list(markdown = TRUE)

R/data-process.R

@@ -3,7 +3,7 @@
 #' This file contains a set of functions designed to work together for processing the data.
 #' Below is a description of how to use these functions in sequence.
 #'
-#' Step-by-Step Usage:
+#' ## Step-by-Step Usage:
 #'
 #' 1. **Read the data**: This function reads the data from the location specified.
 #'    ```{r, eval=FALSE}

R/setup-graphics.R

@@ -38,16 +38,16 @@ set_graphics <- function(width, height){
 #' @details
 #' The `hgps_theme` function modifies the following elements of the classic theme:
 #' \itemize{
-#'   \item \code{plot.title}: Sets the font size of the plot title (default is 15).
-#'   \item \code{axis.title.x}: Sets the font size of the x-axis title (default is 10).
-#'   \item \code{axis.title.y}: Sets the font size of the y-axis title (default is 10).
-#'   \item \code{axis.text.x}: Sets the font size of the x-axis text (default is 8).
-#'   \item \code{axis.text.y}: Sets the font size of the y-axis text (default is 8).
-#'   \item \code{legend.text}: Sets the font size of the legend text (default is 8).
-#'   \item \code{legend.title}: Removes the legend title.
-#'   \item \code{panel.grid.major.x}: Adds major grid lines on the x-axis.
-#'   \item \code{legend.key}: Sets the legend key background (default is "transparent").
-#'   \item \code{legend.position}: Positions the legend (default coordinates are (0.8, 0.9)).
+#'   \item `plot.title`: Sets the font size of the plot title (default is 15).
+#'   \item `axis.title.x`: Sets the font size of the x-axis title (default is 10).
+#'   \item `axis.title.y`: Sets the font size of the y-axis title (default is 10).
+#'   \item `axis.text.x`: Sets the font size of the x-axis text (default is 8).
+#'   \item `axis.text.y`: Sets the font size of the y-axis text (default is 8).
+#'   \item `legend.text`: Sets the font size of the legend text (default is 8).
+#'   \item `legend.title`: Removes the legend title.
+#'   \item `panel.grid.major.x`: Adds major grid lines on the x-axis.
+#'   \item `legend.key`: Sets the legend key background (default is "transparent").
+#'   \item `legend.position`: Positions the legend (default coordinates are (0.8, 0.9)).
 #' }
 #'
 #' @examples