Merge pull request #39 from UBC-MDS/ed_documentation

update description vig
UBC-MDS · Feb 4, 2023 · 3c943bb · 3c943bb
2 parents f81a161 + 7bb0a74
commit 3c943bb
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 12 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -2,3 +2,6 @@
 ^\.Rproj\.user$
 ^LICENSE\.md$
 ^\.github$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,5 @@
 .Rdata
 .httr-oauth
 .DS_Store
+inst/doc
+docs
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -24,3 +24,7 @@ Imports:
     testthat,
     tidyr,
     utils
+Suggests: 
+    knitr,
+    rmarkdown
+VignetteBuilder: knitr
diff --git a/inst/extdata/dsci524.csv b/inst/extdata/dsci524.csv
@@ -0,0 +1,7 @@
+Components,Weights (%),Grades (%)
+lab1,15,90.15
+lab2,15,88.22
+lab3,15,86.65
+lab4,15,88.75
+quiz1,20,90.15
+quiz2,20,90.25
diff --git a/man/load_course.Rd b/man/load_course.Rd
diff --git a/man/save_course_csv.Rd b/man/save_course_csv.Rd
diff --git a/man/update_component_grade.Rd b/man/update_component_grade.Rd
diff --git a/vignettes/gradecalculatorr-vignette.Rmd b/vignettes/gradecalculatorr-vignette.Rmd
@@ -25,7 +25,7 @@ library(gradecalculatorr)
 Next, let's explore the the function construct_course():  
 
 ```{r construct course}
-construct_course('dsci524','/') 
+# construct_course('dsci524','/') 
 #> construct_course('dsci524','/') 
 # What is name of dsci524 component #1? lab1
 # What is weight percentage of dsci524 component #1? 15
@@ -46,28 +46,30 @@ construct_course('dsci524','/')
 # 4       lab4                 15              <NA>
 # 5      quiz1                 20              <NA>
 # 6      quiz2                 20              <NA>
+csv_file <- system.file("extdata", "dsci524.csv", package = "gradecalculatorr")
+
 ```
 Then, let's update the grades:
 
 ```{r update the grades}
-update_component_grade('dsci524.csv', 'lab1', 90.15)
-update_component_grade('dsci524.csv', 'lab2', 88.22)
-update_component_grade('dsci524.csv', 'lab3', 86.65)
-update_component_grade('dsci524.csv', 'lab4', 88.75)
-update_component_grade('dsci524.csv', 'quiz1', 90.15)
+update_component_grade(csv_file, 'lab1', 90.15)
+update_component_grade(csv_file, 'lab2', 88.22)
+update_component_grade(csv_file, 'lab3', 86.65)
+update_component_grade(csv_file, 'lab4', 88.75)
+update_component_grade(csv_file, 'quiz1', 90.15)
 ```
 Then, let's calculate how well the quiz2 has to be in order to get 85% total for course 524:
 
 ```{r predict quiz2 grade}
-predict_final('dsci524.csv', 85)
+predict_final(csv_file, 85)
 # > [1] 69.5
 ```
 
 After quiz2, we know we get 90 for quiz2 and let's calculate the overall grade for course 524:
 
 ```{r calculate the overall grade}
-update_component_grade('dsci524.csv', 'quiz2', 90.25)
-calculate_grade('dsci524.csv')
+update_component_grade(csv_file, 'quiz2', 90.25)
+# calculate_grade(csv_file)
 # > [1] "Course grade is 89.15%"
 ```