add roxygen documentation, export function

PietrH · Aug 1, 2023 · a972478 · a972478
1 parent b1c1444
commit a972478
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -1,2 +1,4 @@
 ^\.github$
 ^LICENSE\.md$
+^.*\.Rproj$
+^\.Rproj\.user$
diff --git a/R/csv_to_markdown_table.R b/R/csv_to_markdown_table.R
@@ -2,6 +2,14 @@ format_link <- function(label, url) {
   sprintf("[%s](%s)", label, url)
 }
 
+#' Convert a csv file to a markdown table
+#'
+#' Also convert two columns to markdown links
+#'
+#' @param csv_path Character. Path to csv file.
+#'
+#' @export
+#'
 csv_to_markdown_table <- function(csv_path) {
   readr::read_csv(csv_path, show_col_types = FALSE) %>%
     dplyr::mutate(

diff --git a/man/csv_to_markdown_table.Rd b/man/csv_to_markdown_table.Rd