Updates to fix CRAN error in check and unrelated documentation

.github/workflows/R-CMD-check.yaml

@@ -2,9 +2,9 @@
 # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
 on:
   push:
-    branches: [main, master]
+    branches: [main, master, dev]
   pull_request:
-    branches: [main, master]
+    branches: [main, master, dev]
 
 name: R-CMD-check.yaml
 

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: IPEDSuploadables
 Title: Transforms Institutional Data into Text Files for IPEDS Automated Import/Upload
-Version: 2.9.0
+Version: 2.9.1
 Authors@R: c(
             person(given = "Alison", family = "Lanski", 
             role = c("aut", "cre"),

NEWS.md

@@ -1,3 +1,7 @@
+# IPEDSuploadables 2.9.1
+* Making function documentation a bit more uniform
+* Changing data load method in vignettes to avoid error on old macos checks
+
 # IPEDSUploadables 2.9.0
 * Addressed 2024-2025 reporting cycle updates from IPEDS (see items below)
 * Graduation rates removed Gender Detail; info longer required in starting data (functions deprecated)

R/create_dummy_data_ef1.R

@@ -7,7 +7,7 @@
 #' @param df_type A string with the dummy data requested ("students" for parts A-D & G-H or "retention" for part E)
 #' @param n A number
 #'
-#' @return A text file
+#' @return A dataframe ready for the rest of the ef1 scripts
 #'
 #' @importFrom rlang .data
 #' @importFrom dplyr group_by summarize ungroup bind_rows arrange transmute n

R/make_com_part_A.R

@@ -9,7 +9,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_com_part_B.R

@@ -8,7 +8,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_com_part_C.R

@@ -7,7 +7,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_com_part_D.R

@@ -8,7 +8,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_com_part_E.R

@@ -11,7 +11,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_e1d_part_A.R

@@ -8,7 +8,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_e1d_part_B.R

@@ -8,7 +8,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_e1d_part_C.R

@@ -8,7 +8,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_e1d_part_D.R

@@ -15,7 +15,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_e1d_part_E.R

@@ -10,7 +10,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_e1d_part_F.R

@@ -9,7 +9,7 @@
 #' @importFrom dplyr select filter distinct
 #' @importFrom stringr str_to_upper
 #'
-#' @return A data frame
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_ef1_part_A.R

@@ -11,7 +11,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_ef1_part_B.R

@@ -10,7 +10,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_ef1_part_C.R

@@ -10,7 +10,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_ef1_part_D.R

@@ -10,7 +10,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_ef1_part_E.R

@@ -9,7 +9,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_ef1_part_F.R

@@ -6,7 +6,7 @@
 #'
 #' @importFrom svDialogs dlg_input
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_ef1_part_G.R

@@ -10,7 +10,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_ef1_part_H.R

@@ -14,7 +14,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_gr200.R

@@ -8,7 +8,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_gr_part_B.R

@@ -8,7 +8,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_gr_part_C.R

@@ -7,7 +7,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_gr_part_E.R

@@ -23,7 +23,7 @@
 #' @importFrom utils write.table
 #' @importFrom stringr str_to_upper
 #'
-#' @return A df aggregated for the survey part
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #' @keywords internal
 #'

R/make_hr_part_A1.R

@@ -8,7 +8,7 @@
 #' @importFrom rlang .data
 #' @importFrom stringr str_to_upper
 #'
-#' @return a txt file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_hr_part_A2.R

@@ -8,7 +8,7 @@
 #' @importFrom rlang .data
 #' @importFrom stringr str_to_upper
 #'
-#' @return a txt file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_hr_part_B1.R

@@ -8,7 +8,7 @@
 #' @importFrom rlang .data
 #' @importFrom stringr str_to_upper
 #'
-#' @return a txt file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_hr_part_B2.R

@@ -8,7 +8,7 @@
 #' @importFrom rlang .data
 #' @importFrom stringr str_to_upper
 #'
-#' @return a txt file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_hr_part_B3.R

@@ -8,7 +8,7 @@
 #' @importFrom rlang .data
 #' @importFrom stringr str_to_upper
 #'
-#' @return a txt file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_hr_part_D1.R

@@ -8,7 +8,7 @@
 #' @importFrom rlang .data
 #' @importFrom stringr str_to_upper
 #'
-#' @return a txt file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_hr_part_D2.R

@@ -8,7 +8,7 @@
 #' @importFrom rlang .data
 #' @importFrom stringr str_to_upper
 #'
-#' @return a txt file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_hr_part_D3.R

@@ -8,7 +8,7 @@
 #' @importFrom rlang .data
 #' @importFrom stringr str_to_upper
 #'
-#' @return a txt file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_hr_part_D4.R

@@ -8,7 +8,7 @@
 #' @importFrom rlang .data
 #' @importFrom stringr str_to_upper
 #'
-#' @return a txt file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_hr_part_G1.R

@@ -9,7 +9,7 @@
 #' @importFrom rlang .data
 #' @importFrom stringr str_to_upper
 #'
-#' @return a txt file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_hr_part_G2.R

@@ -9,7 +9,7 @@
 #' @importFrom rlang .data
 #' @importFrom stringr str_to_upper
 #'
-#' @return a txt file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_hr_part_H1.R

@@ -9,7 +9,7 @@
 #' @importFrom rlang .data
 #' @importFrom stringr str_to_upper
 #'
-#' @return a txt file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_hr_part_H2.R

@@ -8,7 +8,7 @@
 #' @importFrom rlang .data
 #' @importFrom stringr str_to_upper
 #'
-#' @return a txt file
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_om_part_A.R

@@ -7,7 +7,7 @@
 #' @importFrom dplyr group_by summarize ungroup arrange transmute n
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file ready for IPEDS upload
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_om_part_B.R

@@ -7,7 +7,7 @@
 #' @importFrom dplyr transmute
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file ready for IPEDS upload
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_om_part_C.R

@@ -7,7 +7,7 @@
 #' @importFrom dplyr transmute
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file ready for IPEDS upload
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'
 

R/make_om_part_D.R

@@ -8,7 +8,7 @@
 #' @importFrom tidyr pivot_wider replace_na
 #' @importFrom stringr str_to_upper
 #'
-#' @return A text file ready for IPEDS upload
+#' @return A dataframe with the required IPEDS structure for this survey part
 #' @export
 #'