doc for redcap_file_repo_list_oneshot()

ref #549
OuhscBbmc · Oct 25, 2024 · 1bdc662 · 1bdc662
1 parent c55716a
commit 1bdc662
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 5 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -15,6 +15,10 @@ Version 1.4.x  (Not yet released on CRAN)
 
 These features are not yet on CRAN.  Install with `remotes::install_github("OuhscBbmc/REDCapR")`
 
+### New Features
+
+* `redcap_file_repo_list_oneshot()` export a list of files/folders from the file repository (requested by @agdamsbo, #549)
+
 Version 1.3.0  (released 2024-10-22)
 ==========================================================
 

diff --git a/R/redcap-file-repo-list.R b/R/redcap-file-repo-list.R
@@ -1,13 +1,13 @@
 #' @title
 #' Export a List of Files/Folders from the File Repository
-#'#'
+#'
 #' @description
 #' Allows you to export a list of all files and sub-folders from a specific
 #' folder in a project's File Repository.
 #' Each sub-folder will have an associated folder_id number,
 #' and each file will have an associated doc_id number.
 #'
-#' @param folder_id the `folder_id` of a specific folder in the
+#' @param folder_id the integer of a specific folder in the
 #' File Repository for which you wish to export a list of its
 #' files and sub-folders.
 #' If `NA` (the default),

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -46,8 +46,14 @@ reference:
       - redcap_write_oneshot
       - redcap_delete
       - redcap_report
+
+  - title: "File API Operations"
+    desc: >
+      Manipulating files in the REDCap records and in the file repository.
+    contents:
       - redcap_file_download_oneshot
       - redcap_file_upload_oneshot
+      - redcap_file_repo_list_oneshot
 
   - title: "Additional API Methods"
     desc: >

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