Merge pull request #17 from OxfordIHTM/dev

edit pkgdown.yml; fix #13; fix #14; fix #15; fix #16

Author: ernestguevarra

.Rbuildignore

@@ -7,3 +7,4 @@
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+^README\.html$

.github/workflows/test-coverage.yaml

@@ -14,6 +14,7 @@ jobs:
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
       LAWS_AFRICA_TOKEN: ${{ secrets.LAWS_AFRICA_TOKEN }}
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
     steps:
       - uses: actions/checkout@v4

.gitignore

@@ -3,3 +3,5 @@
 .RData
 .Ruserdata
 docs
+
+README.html

DESCRIPTION

@@ -30,7 +30,7 @@ Imports:
 Suggests:
     jsonlite
 LazyData: true
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2
 Roxygen: list(markdown = TRUE)
 URL: https://github.com/OxfordIHTM/africalaws, http://oxford-ihtm.io/africalaws/
 BugReports: https://github.com/OxfordIHTM/africalaws/issues

README.Rmd

@@ -40,7 +40,7 @@ From here, the plan is to continue developing functions that wrap the various av
 
 ## Installation
 
-`africalaws` is not yet on CRAN but can be installed from the [Oxford IHTM R universe](https://oxfordihtm.r-universe.dev) as follows:
+`africalaws` is not yet on CRAN but can be installed from the [Oxford IHTM R Universe](https://oxfordihtm.r-universe.dev) as follows:
 
 ```{r install-r-universe, eval = FALSE}
 install.packages(

README.md

@@ -37,9 +37,9 @@ working version.
 
 Currently, the package provides functions for:
 
-- Authenticating with the Laws.Africa API;
-- Performing a call to the `countries` API endpoint; and,
-- Performing a call to the `works` API endpoint.
+  - Authenticating with the Laws.Africa API;
+  - Performing a call to the `countries` API endpoint; and,
+  - Performing a call to the `works` API endpoint.
 
 From here, the plan is to continue developing functions that wrap the
 various available [API
@@ -48,7 +48,7 @@ endpoints](https://developers.laws.africa/api/about-the-api).
 ## Installation
 
 `africalaws` is not yet on CRAN but can be installed from the [Oxford
-IHTM R universe](https://oxfordihtm.r-universe.dev) as follows:
+IHTM R Universe](https://oxfordihtm.r-universe.dev) as follows:
 
 ``` r
 install.packages(
@@ -61,13 +61,13 @@ install.packages(
 
 The following vignettes describe how to use the `africalaws` package.
 
-- Authenticating with the Laws.Africa API
+  - Authenticating with the Laws.Africa API
 
-- Listing out countries and areas/locations with available works from
-  the Laws.Africa API
+  - Listing out countries and areas/locations with available works from
+    the Laws.Africa API
 
-- Listing out works for a specific country or areas/locations that are
-  available from the Laws.Africa API
+  - Listing out works for a specific country or areas/locations that are
+    available from the Laws.Africa API
 
 ## Citation
 
@@ -79,16 +79,15 @@ follows:
 citation("africalaws")
 #> To cite africalaws in publications use:
 #> 
-#>   Jillian Francise Lee, Sanjeev Pugazhendhi, Ernest Guevarra, and
-#>   Proochista Ariana (2024). africalaws: Interface to the Laws.Africa
-#>   API. R package version 0.0.9000. URL
-#>   https://oxford-ihtm.io/africalaws/
+#>   Jillian Francise Lee, Ernest Guevarra (2024). _africalaws: Interface
+#>   to the Laws.Africa API_. R package version 0.0.9000,
+#>   <https://oxford-ihtm.io/africalaws/>.
 #> 
 #> A BibTeX entry for LaTeX users is
 #> 
 #>   @Manual{,
 #>     title = {africalaws: Interface to the Laws.Africa API},
-#>     author = {{Jillian Francise Lee} and {Sanjeev Pugazhendhi} and {Ernest Guevarra} and {Proochista Ariana}},
+#>     author = {{Jillian Francise Lee} and {Ernest Guevarra}},
 #>     year = {2024},
 #>     note = {R package version 0.0.9000},
 #>     url = {https://oxford-ihtm.io/africalaws/},

pkgdown/_pkgdown.yml

@@ -2,39 +2,39 @@ title: africalaws
 
 url: https://oxford-ihtm.io/africalaws/
 
+development:
+  mode: auto
+
 template:
   bootstrap: 5
-  bootswatch: litera
-  theme: haddock
-  ganalytics: #
+  bootswatch: journal
+  theme: breeze-light
+  ganalytics: G-9C8W5NMF8N
 
 home:
   links:
   - text: Read more about Laws.Africa
     href: https://laws.africa/about
 
 navbar:
-  bg: primary
+  bg: info
   type: light
   structure:
     left:  [home, intro, reference, articles, news]
-    right: [twitter, facebook, linkedin, github]
+    right: [search, linkedin, mastodon, github]
 
   components:
     # articles:
     #   text: Articles
     #   menu:
     #   - text: "ICD-11 Foundation"
     #     href: articles/icd11_foundation.html
-    twitter:
-      icon: "fab fa-twitter fa-lg"
-      href: http://twitter.com/OxIHTM
-    facebook:
-      icon: "fab fa-facebook fa-lg"
-      href: https://www.facebook.com/MSc-in-International-Health-and-Tropical-Medicine-University-of-Oxford-433056700228246/
     linkedin:
       icon: "fab fa-linkedin fa-lg"
-      href: https://www.linkedin.com/company/international-health-and-tropical-medicine
+      href: https://www.linkedin.com/company/oxford-ihealth
+    mastodon:
+      icon: "fab fa-mastodon fa-lg"
+      href: https://mastodon.social/@ihealth
 
 
 reference: