Merge pull request #260 from PIP-Technical-Team/wb_update_rt

Some webpage modifications

.github/workflows/pkgdown.yaml

@@ -1,50 +1,48 @@
 on:
   push:
-    branches:
-      - main
-      - master
-    tags:
-      -'*'
+    branches: [DEV, PROD]
+  pull_request:
+    branches: [DEV, PROD]
+  release:
+    types: [published]
+  workflow_dispatch:
 
 name: pkgdown
 
+permissions: read-all
+
 jobs:
   pkgdown:
-    runs-on: macOS-latest
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
     steps:
-      - uses: actions/checkout@v2
-
-      - uses: r-lib/actions/setup-r@v1
+      - uses: actions/checkout@v4
 
-      - uses: r-lib/actions/setup-pandoc@v1
+      - uses: r-lib/actions/setup-pandoc@v2
 
-      - name: Query dependencies
-        run: |
-          install.packages('remotes')
-          saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
-          writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
-        shell: Rscript {0}
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
 
-      - name: Restore R package cache
-        uses: actions/cache@v2
+      - uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          path: ${{ env.R_LIBS_USER }}
-          key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
-          restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
-
-      - name: Install dependencies
-        run: |
-          remotes::install_deps(dependencies = TRUE)
-          install.packages("pkgdown", type = "binary")
-        shell: Rscript {0}
+          extra-packages: any::pkgdown, local::.
+          needs: website
 
-      - name: Install package
-        run: R CMD INSTALL .
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
 
-      - name: Deploy package
-        run: |
-          git config --local user.email "actions@github.com"
-          git config --local user.name "GitHub Actions"
-          Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)'
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/github-pages-deploy-action@v4.5.0
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

.gitignore

@@ -8,5 +8,4 @@ doc/
 Meta/
 tests/testdata/local/
 TEMP/
-docs
 /sessionInfoLog

DESCRIPTION

@@ -45,8 +45,8 @@ Suggests:
     rmarkdown,
     markdown,
     readr,
-    pipr
-URL: https://pip-technical-team.github.io/wbpip, https://github.com/PIP-Technical-Team/wbpip
+    pipr (>= 1.0.0)
+URL: https://pip-technical-team.github.io/wbpip, https://github.com/PIP-Technical-Team/wbpip, https://pip-technical-team.github.io/wbpip/
 BugReports: https://github.com/PIP-Technical-Team/wbpip/issues
 Depends: 
     R (>= 3.5.0)
@@ -62,3 +62,5 @@ Imports:
 VignetteBuilder: knitr
 ByteCompile: true
 Config/testthat/edition: 3
+Remotes:  
+    github::worldbank/pipr

_pkgdown.yml

@@ -1 +1,106 @@
-url: https://pip-technical-team.github.io/wbpip
+url: https://pip-technical-team.github.io/wbpip/
+template:
+  bootstrap: 5
+  bottswatch: lux
+  bslib:
+    primary: '#76ABDF'
+development:
+  mode: auto
+navbar:
+  bg: primary
+  structure:
+    right: github
+  components:
+    github:
+      icon: fab fa-github fa-lg
+      href: https://github.com/PIP-Technical-Team/wbpip
+
+reference:
+- title: Microdata
+  contents:
+  - md_ABC_2000_income
+  - md_ABC_2010_income
+  - md_DEF_2000_consumption
+  - md_GHI_2000_consumption
+  - md_GHI_2000_income
+- title: Grouped data
+  contents:
+  - grouped_data_ex1
+  - grouped_data_ex2
+  - grouped_data_ex3
+  - gd_GHI_2009_income
+  - gd_clean_data
+  - gd_estimate_distribution
+
+- title: Lorenz Curve Validity Checks
+  contents:
+  - check_curve_validity_lb
+  - check_curve_validity_lq
+- title: Lorenz Functional Form Creation
+  contents:
+  - create_functional_form_lb
+  - create_functional_form_lq
+- title: Derivative Calculations
+  contents:
+  - derive_lb
+  - derive_lq
+- title: Lorenz Curve Solvers/Computations
+  contents:
+  - value_at_lb
+  - value_at_lq
+  - get_lorenz
+  - md_compute_lorenz
+  - regres
+
+- title: Distributional and Poverty Statistics Algorithms
+  contents:
+  - use_lq_for_distributional
+  - use_lq_for_poverty
+
+- title: Model Fitting and Statistics (Grouped Data)
+  contents:
+  - gd_compute_fit_lb
+  - gd_compute_fit_lq
+  - gd_compute_gini_lb
+  - gd_compute_gini_lq
+  - gd_compute_headcount_lb
+  - gd_compute_headcount_lq
+  - gd_compute_mld_lb
+  - gd_compute_mld_lq
+  - gd_compute_polarization_lb
+  - gd_compute_polarization_lq
+  - gd_compute_pov_gap_lb
+  - gd_compute_pov_gap_lq
+  - gd_compute_pov_severity_lb
+  - gd_compute_pov_severity_lq
+  - gd_compute_watts_lb
+  - gd_compute_watts_lq
+
+- title: Poverty and Inequality Measures
+  contents:
+  - fill_gaps
+  - compute_pip_stats
+  - md_compute_cumulative_share
+  - md_compute_fgt
+  - md_compute_headcount
+  - md_compute_pov_gap
+  - md_compute_pov_severity
+  - md_compute_watts
+  - md_compute_mld
+  - md_compute_polarization
+  - md_compute_poverty_stats
+  - get_gini
+  - md_compute_gini
+  - prod_compute_pip_stats
+
+- title: Welfare Statistics
+  contents:
+  - deflate_welfare_mean
+  - get_bins
+  - predict_request_year_mean
+  - get_9010_ratio
+  - get_average_shortfall
+  - get_income_gap_ratio
+  - get_number_poor
+  - get_palma_ratio
+  - get_total_shortfall