update documentation

R/create_ald_flag.R

@@ -1,12 +1,16 @@
-#' A short description of the function
+#' Add columns to flag existence of data in ABCD for each holding
 #'
-#' A longer description of the function
+#' Adds columns to a portfolio data frame flagging the existence of data related
+#' to each holding in the ABCD data. It will add the `has_asset_level_data`,
+#' `sectors_with_assets`, and `has_ald_in_fin_sector` columns.
 #'
-#' @param portfolio A description of the argument
-#' @param comp_fin_data A description of the argument
-#' @param debt_fin_data A description of the argument
+#' @param portfolio A data frame containing portfolio data
+#' @param comp_fin_data A data frame containing company financial data
+#' @param debt_fin_data A data frame containing debt financial data
 #'
-#' @return A description of the return value
+#' @return A data frame similar to the input portfolion data frame with three
+#'   added columns `has_asset_level_data`, `sectors_with_assets`, and
+#'   `has_ald_in_fin_sector`
 #'
 #' @export
 

R/create_audit_file.R

@@ -1,11 +1,12 @@
-#' A short description of the function
+#' Create the audit file for a processed portfolio
 #'
-#' A longer description of the function
+#' Creates an audit file from a processed portfolio, selecting the expected
+#' columns.
 #'
-#' @param portfolio_total A description of the argument
+#' @param portfolio_total A data frame
 #' @param has_revenue Logical determining if revenue data is included or not
 #'
-#' @return A description of the return value
+#' @return A data frame
 #'
 #' @export
 

R/export_audit_information_data.R

@@ -1,13 +1,18 @@
-#' A short description of the function
+#' Export audit data for Transition Monitor website
 #'
-#' A longer description of the function
+#' Exports three audit files for the Transition Monitor website, allowing the
+#' website GUI to report to the user details about the audit process result.
 #'
-#' @param audit_file_ A description of the argument
-#' @param portfolio_total_ A description of the argument
-#' @param folder_path A description of the argument
-#' @param project_name_ A description of the argument
+#' @param audit_file_ A data frame containing the audit data
+#' @param portfolio_total_ A data frame containing the processed portfolio data
+#' @param folder_path A length one character vector specifying the path where
+#'   the exported audit files should be saved
+#' @param project_name_ An optional length one character vector specifying a
+#'   project name to prepend to the filenames. Default is `NA` which has no
+#'   effect.
 #'
-#' @return A description of the return value
+#' @return Returns `NULL` invisibly as it is called only for its side effect of
+#'   saving files
 #'
 #' @export
 

R/get_input_files.R

@@ -3,7 +3,7 @@
 #' A longer description of the function
 #'
 #' @param portfolio_name_ref_all A description of the argument
-#' @param project_location A charcter string defining the path to the user's
+#' @param project_location A character string defining the path to the user's
 #'   data directory, usually "working_dir" and the value held in the
 #'   `project_location` parameter
 #'