docs: update roxygen documentation and pkgdown site files

- Add roxygen documentation for .onLoad function - Update pkgdown configuration and reference pages - Generate package documentation HTML files - Update quickstart guide and vignettes - Update NAMESPACE and DESCRIPTION files
davidycliao · Jan 5, 2025 · 6ad48ba · 6ad48ba
1 parent f9f40e8
commit 6ad48ba
Show file tree

Hide file tree

Showing 19 changed files with 149 additions and 38 deletions.
diff --git a/.Rproj.user/763C8F27/pcs/files-pane.pper b/.Rproj.user/763C8F27/pcs/files-pane.pper
@@ -9,5 +9,5 @@
             "ascending": true
         }
     ],
-    "path": "~/Dropbox/My Packages/legisTaiwan/vignettes"
+    "path": "~/Dropbox/My Packages/legisTaiwan/R"
 }
diff --git a/.Rproj.user/763C8F27/pcs/source-pane.pper b/.Rproj.user/763C8F27/pcs/source-pane.pper
@@ -1,3 +1,3 @@
 {
-    "activeTab": 1
+    "activeTab": 4
 }
diff --git a/.Rproj.user/763C8F27/sources/prop/70BF7A76 b/.Rproj.user/763C8F27/sources/prop/70BF7A76
@@ -1,6 +1,6 @@
 {
     "source_window_id": "",
     "Source": "Source",
-    "cursorPosition": "38,7",
-    "scrollLine": "26"
+    "cursorPosition": "8,1",
+    "scrollLine": "0"
 }
diff --git a/.Rproj.user/763C8F27/sources/prop/A6FC25F9 b/.Rproj.user/763C8F27/sources/prop/A6FC25F9
@@ -1,6 +1,6 @@
 {
     "source_window_id": "",
     "Source": "Source",
-    "cursorPosition": "30,11",
-    "scrollLine": "0"
+    "cursorPosition": "27,10",
+    "scrollLine": "6"
 }
diff --git a/.Rproj.user/763C8F27/sources/prop/DFE1904A b/.Rproj.user/763C8F27/sources/prop/DFE1904A
@@ -1,8 +1,8 @@
 {
     "source_window_id": "",
     "Source": "Source",
-    "cursorPosition": "51,101",
-    "scrollLine": "40",
+    "cursorPosition": "82,107",
+    "scrollLine": "69",
     "docOutlineVisible": "1",
     "docOutlineSize": "286"
 }
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -24,6 +24,8 @@ Imports:
     rvest,
     withr,
     httr,
+    pillar,
+    vctrs,
     utils,
     readr,
     dplyr,

diff --git a/NAMESPACE b/NAMESPACE
@@ -26,6 +26,7 @@ export(get_public_debates)
 export(get_speech_video)
 export(get_tly_stat)
 export(get_variable_info)
+export(type_sum.accel)
 import(ggplot2)
 import(utils)
 importFrom(attempt,stop_if_all)

diff --git a/R/zzz.R b/R/zzz.R
@@ -1,3 +1,14 @@
+
+#' Register S3 methods and set up package
+#' @keywords internal
+.onLoad <- function(libname, pkgname) {
+  # 檢查並註冊 S3 方法
+  if (requireNamespace("vctrs", quietly = TRUE)) {
+    vctrs::s3_register("pillar::type_sum", "accel")
+  }
+}
+
+
 #' On package attach, display a startup message
 #'
 #' @keywords internal
@@ -40,3 +51,8 @@
   packageStartupMessage(message1)
   packageStartupMessage(message2)
 }
+
+#' @export
+type_sum.accel <- function(x) {
+  "accel"
+}
diff --git a/docs/articles/quickstart.html b/docs/articles/quickstart.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -3,7 +3,7 @@ pkgdown: 2.1.1
 pkgdown_sha: ~
 articles:
   quickstart: quickstart.html
-last_built: 2025-01-05T00:27Z
+last_built: 2025-01-05T00:41Z
 urls:
   reference: https://davidycliao.github.io/legisTaiwan/reference
   article: https://davidycliao.github.io/legisTaiwan/articles
diff --git a/docs/reference/dot-onLoad.html b/docs/reference/dot-onLoad.html
diff --git a/docs/reference/get_caucus_meetings.html b/docs/reference/get_caucus_meetings.html
diff --git a/docs/reference/get_executive_response.html b/docs/reference/get_executive_response.html
diff --git a/docs/reference/get_legislators.html b/docs/reference/get_legislators.html
diff --git a/docs/reference/get_meetings.html b/docs/reference/get_meetings.html
diff --git a/docs/reference/get_parlquestions.html b/docs/reference/get_parlquestions.html
diff --git a/docs/search.json b/docs/search.json
diff --git a/man/dot-onLoad.Rd b/man/dot-onLoad.Rd
diff --git a/vignettes/quickstart.Rmd b/vignettes/quickstart.Rmd
@@ -70,21 +70,21 @@ The Legislative Yuan API is transitioning from `https://ly.govapi.tw` to `https:
 
 ### Bill 
 
-- [`get_ly_bills()`](): Fetch and Parse Legislative Yuan Bills
+- [`get_ly_bills()`](#docs/reference/get_ly_bills.html): Fetch and Parse Legislative Yuan Bills
 
 ### Committees 
 
-- [`get_ly_committee_meets()`](): Fetch Legislative Yuan Committee Meetings
+- [`get_ly_committee_meets()`](#docs/reference/get_ly_committee_meets.html): Fetch Legislative Yuan Committee Meetings
 
-- [`get_ly_committees_type()`](): Fetch and Parse Legislative Yuan Committee Details, Jurisdiction and Codes
+- [`get_ly_committees_type()`](#docs/reference/get_ly_committees_type.html): Fetch and Parse Legislative Yuan Committee Details, Jurisdiction and Codes
 
 ### Interpellation
 
-- [`get_ly_interpellations()`](): Get Legislative Yuan Interpellation Records
+- [`get_ly_interpellations()`](#docs/reference/get_ly_interpellations.html): Get Legislative Yuan Interpellation Records
 
 ###  IVOD
 
-- [`get_ly_ivod()`](): Get Legislative Yuan IVOD Records
+- [`get_ly_ivod()`](#docs/reference/get_ly_ivod.html): Get Legislative Yuan IVOD Records
 
 <br>
-Original file line number
+Diff line change
@@ Expand Up / @@ -24,6 +24,8 @@ Imports: @@
         rvest,
         withr,
         httr,
+        pillar,
+        vctrs,
         utils,
         readr,
         dplyr,
@@ Expand Down @@