closes #37

Author: federicazoe

R/assist_grading-wrappers.R

@@ -8,7 +8,8 @@
 #'     This is that path for that file. Must be a .csv
 #' @param final_grade_sheet_path string; path to save final grade sheet to. Must be a .csv
 #' @param example_assignment_path string; file path(s) to the file(s) constituting one of the submissions to be graded. 
-#'     This file path structure will be used to determine where the other submissions to be graded are located. 
+#'     This file(s) must have a format that can be opened by rstudioapi::navigateToFile(). 
+#'     This file path(s) structure will be used to determine where the other submissions to be graded are located. 
 #'     The student identifier has to be present somewhere in each file path(s).
 #'     If specified as "no_submissions", grading will proceed without automatic interaction with assignments (i.e opening and closing assignments).
 #'     If example_assignment_path is a vector of multiple file paths, gradetools will look for each of these files when grading a submission, and open all files it successfully finds for the given student or team.

R/create_grading_progress_log.R

@@ -3,7 +3,8 @@
 #' @param grading_progress_log_path string; assist-grading() functions save a file which includes information for gradetools's internal use. 
 #'     This is that path for that file. Must be a .csv
 #' @param example_assignment_path string; file path(s) to the file(s) constituting one of the submissions to be graded. 
-#'     This file path structure will be used to determine where the other submissions to be graded are located. 
+#'     This file(s) must have a format that can be opened by rstudioapi::navigateToFile(). 
+#'     This file path(s) structure will be used to determine where the other submissions to be graded are located. 
 #'     The student identifier has to be present somewhere in each file path(s).
 #'     If specified as "no_submissions", grading will proceed without automatic interaction with assignments (i.e opening and closing assignments).
 #'     If example_assignment_path is a vector of multiple file paths, gradetools will look for each of these files when grading a submission, and open all files it successfully finds for the given student or team.

vignettes/a-grading-with-gradetools.Rmd

@@ -126,7 +126,8 @@ From the previous sections in this vignette, we already know our rubric and rost
 
 The `example_student_identifier` corresponds to any of the identifiers present in the `student_identifier` column of the roster.
 
-The `example_assignment_path` is the path where the file(s) associated with the submission of example_student_identifier are located.
+The `example_assignment_path` is the path where the file(s) associated with the submission of example_student_identifier are located. 
+This file(s) must have a format that can be opened by `rstudioapi::navigateToFile()`. 
 
 The `example_feedback_path` is the path where the grader wishes to save the feedback file associated with the `example_student_identifier`. The extension of this path dictates the file type. The current options for extensions are "Rmd", "md", "docx", "html", "pdf". The feedback files are knitted to the accompanying file type (except for Rmd files): GitHub, Word, html, pdf documents respectively.