merge branch dev

Author: AntiportaD

.DS_Store

@@ -10,10 +10,14 @@ Authors@R: c(
     person("Ahmad", "Hosseinpoor", , "[email protected]", role = "aut"),
     person("World Health Organization", , , "[email protected]", role = "cph")
   )
-Description: Functions for computing summary measures of health
-    inequality.
+Description: Compute 21 summary measures of health inequality and its
+    corresponding confidence intervals for ordered and non-ordered
+    dimensions using disaggregated (grouped) data. Measures for ordered
+    dimensions (i.e., Slope Index of Inequality) also accept individual
+    and survey data.
 License: AGPL (>= 3)
-URL: https://github.com/WHOequity/healthequal, https://whoequity.github.io/healthequal/
+URL: https://github.com/WHOequity/healthequal,
+    https://whoequity.github.io/healthequal/
 BugReports: https://github.com/WHOequity/healthequal/issues
 Depends:
     R (>= 3.5.0)

DESCRIPTION

@@ -3,9 +3,10 @@ output: github_document
 ---
 
 <!-- badges: start -->
-
 [![R-CMD-check](https://github.com/WHOequity/healthequal/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/WHOequity/healthequal/actions/workflows/R-CMD-check.yaml)
-
+[![CRAN status](https://www.r-pkg.org/badges/version/healthequal)](https://CRAN.R-project.org/package=healthequal)
+[![Project Status: Concept](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+[![License: AGPL (>= 3)](https://img.shields.io/badge/License-AGPL%20%28%3E%3D%203%29-blue.svg)](https://choosealicense.com/licenses/agpl-3.0/)
 <!-- badges: end -->
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
@@ -21,7 +22,7 @@ knitr::opts_chunk$set(
 library(healthequal)
 ```
 
-# healthequal <a href='https://github.com/WHOequity/healthequal/'>
+# healthequal <a href="https://whoequity.github.io/healthequal/"><img src="man/figures/logo.png" align="right" height="139" alt="healthequal website" /></a>
 
 The healthequal R package provides computational tools for calculating summary measures of health inequality.
 

README.Rmd

@@ -2,11 +2,17 @@
 <!-- badges: start -->
 
 [![R-CMD-check](https://github.com/WHOequity/healthequal/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/WHOequity/healthequal/actions/workflows/R-CMD-check.yaml)
-
+[![CRAN
+status](https://www.r-pkg.org/badges/version/healthequal)](https://CRAN.R-project.org/package=healthequal)
+[![Project Status:
+Concept](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+[![License: AGPL (\>=
+3)](https://img.shields.io/badge/License-AGPL%20%28%3E%3D%203%29-blue.svg)](https://choosealicense.com/licenses/agpl-3.0/)
 <!-- badges: end -->
+
 <!-- README.md is generated from README.Rmd. Please edit that file -->
 
-# healthequal <a href='https://github.com/WHOequity/healthequal/'>
+# healthequal <a href="https://whoequity.github.io/healthequal/"><img src="man/figures/logo.png" align="right" height="139" alt="healthequal website" /></a>
 
 The healthequal R package provides computational tools for calculating
 summary measures of health inequality.

README.md

@@ -1,4 +1,42 @@
 url: https://whoequity.github.io/healthequal/
 template:
   bootstrap: 5
+bslib:
+    base_font: {google: "Roboto"}
+    heading_font: {google: "Roboto Slab"}
+    code_font: {google: "JetBrains Mono"}
 
+reference:
+- title: "Package data"
+  contents:
+  - data
+
+- title: "Summary measures for ordered dimensions"
+  contents:
+  - aci
+  - rci
+  - sii
+  - rii
+
+- title: "Summary measures for non-ordered dimensions"
+  contents:
+  - bgv
+  - bgsd
+  - covar
+  - d
+  - idisu
+  - idisw
+  - mdbu
+  - mdbw
+  - mdmu
+  - mdmw
+  - mdru
+  - mdrw
+  - mld
+  - r
+  - ti
+
+- title: "Summary measures for both ordered and non-ordered dimensions"
+  contents:
+  - par
+  - paf

_pkgdown.yml

@@ -1,4 +1,5 @@
 ACI
+AGPL
 Ahn
 BGSD
 BGV

inst/WORDLIST

@@ -0,0 +1,40 @@
+# Create Hex Sticker
+library(showtext)
+library(hexSticker)
+
+## Loading Google fonts (http://www.google.com/fonts)
+font_add_google("Inconsolata", "incon")
+## Automatically use showtext to render text for future devices
+showtext_auto()
+
+sticker(
+  # Subplot (image)
+  subplot = "inst/figures/background.png",       # Image name
+  s_y = 1,                          # Position of the sub plot (y)
+  s_x = 1.01,                       # Position of the sub plot (x)
+  s_width = .85,                   # Width of the sub plot
+  s_height=0.1,                    # Height of the sub plot
+  # Font
+  package = "healthequal",            # Package name (will be printed on the sticker)
+  p_size = 80,                       # Font size of the text
+  p_y = 0.65,                        # Position of the font (y)
+  p_x=1.05,                         # Position of the font (x)
+  p_family = "incon",               # Defines font
+  p_color = "#008dc9",
+  p_fontface = "bold",
+  # Spotlight
+  spotlight = TRUE,                 # Enables spotlight
+  l_y=0.6,                          # Position of spotlight (y)
+  l_x=1.03,                          # Position of spotlight (x)
+  l_width = 10,
+  l_height = 3,
+  l_alpha = 0.9,
+  # Sticker colors
+  h_size = 1.2,
+  h_fill = "#f5f5f5",               # Color for background
+  h_color = "#008dc9",              # Color for borders
+  # Resolution
+  dpi=1200,                         # Sets DPI
+  # Save
+  filename="inst/logo/logo.png"               # Sets file name and location where to store the sticker
+)