initial build of vignettes

.gitignore

@@ -4,3 +4,4 @@
 .gitattributes
 .Rhistory
 docs
+inst/doc

DESCRIPTION

@@ -2,20 +2,21 @@ Package: FairnessTutorial
 Title: What the Package Does (One Line, Title Case)
 Version: 0.0.0.9000
 Authors@R: 
-    person("First", "Last", , "first.last@example.com", role = c("aut", "cre"),
-           comment = c(ORCID = "YOUR-ORCID-ID"))
+    person("Jianhui", "Gao", , "jianhui.gao@mail.utoronto.ca", role = c("aut", "cre"))
 Description: What the package does (one paragraph).
 Imports:
   magrittr
-License: `use_mit_license()`, `use_gpl3_license()` or friends to pick a
-    license
+License: use_mit_license()
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.2.3
 Suggests: 
+    knitr,
+    rmarkdown,
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
 Depends: 
     R (>= 2.10)
 LazyData: true
 URL: https://jianhuig.github.io/FairnessTutorial/
+VignetteBuilder: knitr

docs/pkgdown.yml

@@ -1,6 +1,11 @@
 pandoc: 3.1.1
 pkgdown: 2.0.7
 pkgdown_sha: ~
-articles: {}
-last_built: 2024-03-04T19:11Z
+articles:
+  my-vignette: my-vignette.html
+  preprocess: preprocess.html
+last_built: 2024-03-04T20:10Z
+urls:
+  reference: https://jianhuig.github.io/FairnessTutorial/reference
+  article: https://jianhuig.github.io/FairnessTutorial/articles
 

docs/sitemap.xml

@@ -1,90 +1,99 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
   <url>
-    <loc>/404.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/404.html</loc>
   </url>
   <url>
-    <loc>/LICENSE-text.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/LICENSE-text.html</loc>
   </url>
   <url>
-    <loc>/authors.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/articles/index.html</loc>
   </url>
   <url>
-    <loc>/index.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/articles/my-vignette.html</loc>
   </url>
   <url>
-    <loc>/reference/equal_opportunity.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/articles/preprocess.html</loc>
   </url>
   <url>
-    <loc>/reference/equalized_odds.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/authors.html</loc>
   </url>
   <url>
-    <loc>/reference/eval_acc_parity.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/index.html</loc>
   </url>
   <url>
-    <loc>/reference/eval_bs_parity.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/equal_opportunity.html</loc>
   </url>
   <url>
-    <loc>/reference/eval_cond_acc_equality.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/equalized_odds.html</loc>
   </url>
   <url>
-    <loc>/reference/eval_cond_stats_parity.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/eval_acc_parity.html</loc>
   </url>
   <url>
-    <loc>/reference/eval_eq_odds.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/eval_bs_parity.html</loc>
   </url>
   <url>
-    <loc>/reference/eval_eq_opp.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/eval_cond_acc_equality.html</loc>
   </url>
   <url>
-    <loc>/reference/eval_generalized_entropy_index.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/eval_cond_stats_parity.html</loc>
   </url>
   <url>
-    <loc>/reference/eval_max_abs_diff.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/eval_eq_odds.html</loc>
   </url>
   <url>
-    <loc>/reference/eval_max_min_diff.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/eval_eq_opp.html</loc>
   </url>
   <url>
-    <loc>/reference/eval_max_min_ratio.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/eval_generalized_entropy_index.html</loc>
   </url>
   <url>
-    <loc>/reference/eval_mean_abs_dev.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/eval_max_abs_diff.html</loc>
   </url>
   <url>
-    <loc>/reference/eval_neg_class_bal.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/eval_max_min_diff.html</loc>
   </url>
   <url>
-    <loc>/reference/eval_pos_class_bal.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/eval_max_min_ratio.html</loc>
   </url>
   <url>
-    <loc>/reference/eval_pred_equality.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/eval_mean_abs_dev.html</loc>
   </url>
   <url>
-    <loc>/reference/eval_pred_parity.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/eval_neg_class_bal.html</loc>
   </url>
   <url>
-    <loc>/reference/eval_stats_parity.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/eval_pos_class_bal.html</loc>
   </url>
   <url>
-    <loc>/reference/eval_treatment_equality.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/eval_pred_equality.html</loc>
   </url>
   <url>
-    <loc>/reference/eval_variance.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/eval_pred_parity.html</loc>
   </url>
   <url>
-    <loc>/reference/get_all_metrics.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/eval_stats_parity.html</loc>
   </url>
   <url>
-    <loc>/reference/get_fpr.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/eval_treatment_equality.html</loc>
   </url>
   <url>
-    <loc>/reference/get_tpr.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/eval_variance.html</loc>
   </url>
   <url>
-    <loc>/reference/index.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/get_all_metrics.html</loc>
   </url>
   <url>
-    <loc>/reference/mimic.html</loc>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/get_fpr.html</loc>
+  </url>
+  <url>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/get_tpr.html</loc>
+  </url>
+  <url>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/index.html</loc>
+  </url>
+  <url>
+    <loc>https://jianhuig.github.io/FairnessTutorial/reference/mimic.html</loc>
   </url>
 </urlset>

vignettes/.gitignore

@@ -0,0 +1,2 @@
+*.html
+*.R