Merge pull request #4 from izaak-jephson/main

Udpate documentation
ScotGovAnalysis · Sep 5, 2024 · 9dff22c · 9dff22c
2 parents d9b0605 + 2eaa457
commit 9dff22c
Show file tree

Hide file tree

Showing 10 changed files with 67 additions and 13 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -15,7 +15,8 @@ Imports:
     openxlsx,
     purrr,
     rlang,
-    stringr
+    stringr,
+    tibble
 Suggests: 
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
diff --git a/NAMESPACE b/NAMESPACE
@@ -10,12 +10,15 @@ export(add_notes_sheet)
 export(add_sheet_to_metadata)
 export(create_metadata)
 export(create_table_layout)
+export(create_template_output)
 export(format_columns)
 export(format_rows)
 export(generate_table_metadata)
 export(make_contents_table)
 export(make_output_tables)
 export(negative_to_c)
+export(save_output_tables)
+export(table_list_to_tibble)
 export(tweak_formatting)
 importFrom(magrittr,"%>%")
 importFrom(rlang,.data)
diff --git a/R/build_metadata.R b/R/build_metadata.R
@@ -1,7 +1,7 @@
 #' Initialise Metadata Object
 #'
 #' @description Creates an empty metadata object which can be added to with
-#' `r xlsss::add_sheet_to_metadata`
+#' `xlsss::add_sheet_to_metadata`
 #' @export
 create_metadata <- function(){
 
@@ -42,7 +42,7 @@ add_sheet_to_metadata <- function(metadata,
 #' Combine Metadata and Tables to Create Layout
 #'
 #' Takes a metadata object and adds specified table_data to create a table layout to
-#' be passed to `r xlsss::make_output_tables`
+#' be passed to `xlsss::make_output_tables`
 #' @param metadata Metadata object
 #' @param table_data Tibble of tables. Must include columns: name, table and title.
 #' `name` column must match the table names specified in the metadata object.
@@ -126,7 +126,7 @@ generate_table_metadata <- function(table_names,
 #' Convert List of Tables to table_data
 #'
 #' @description Helper function for quickly turning named list of tables into a
-#' table_data object for use in the `r xlsss::create_table_layout` function.
+#' table_data object for use in the `xlsss::create_table_layout` function.
 #' @param table_list List of tables to be converted to table_data
 #' @export
 table_list_to_tibble <- function(table_list){

diff --git a/R/export_tables.R b/R/export_tables.R
@@ -552,7 +552,7 @@ make_output_tables <- function(metadata,
                                notes_list,
                                contents_title) {
 
-  if(!is_tibble(table_data)){
+  if(!tibble::is_tibble(table_data)){
     table_data <- table_list_to_tibble(table_data)}
 
   table_layout <- create_table_layout(metadata, table_data)

diff --git a/man/create_metadata.Rd b/man/create_metadata.Rd
diff --git a/man/create_table_layout.Rd b/man/create_table_layout.Rd
diff --git a/man/create_template_output.Rd b/man/create_template_output.Rd
diff --git a/man/make_output_tables.Rd b/man/make_output_tables.Rd
diff --git a/man/save_output_tables.Rd b/man/save_output_tables.Rd
diff --git a/man/table_list_to_tibble.Rd b/man/table_list_to_tibble.Rd