edit citation and readme

Author: AntiportaD

README.Rmd

@@ -3,7 +3,9 @@ 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)
+
 <!-- badges: end -->
 
 <!-- README.md is generated from README.Rmd. Please edit that file -->
@@ -21,7 +23,6 @@ library(healthequal)
 
 # healthequal <a href='https://github.com/WHOequity/healthequal/'>
 
-
 The healthequal R package provides computational tools for calculating summary measures of health inequality.
 
 # Installation
@@ -43,55 +44,70 @@ remotes::install_github("WHO/helathequal")
 
 The following summary measures of health inequality are included in the `healthequal` package:
 
-###   Simple measures
-    -   Difference (`d`)
-    -   Ratio (`r`)
-###   Disproportionality measures (ordered dimensions)
-    -   Absolute concentration index (`aci`)
-    -   Relative concentration index (`rci`)
-###  Regression-based measures (ordered dimensions)
-    -   Slope index of inequality (`sii`)
-    -   Relative index of inequality (`rii`)
-###   Variance measures (non-ordered dimensions)
-    -   Between-group variance (`bgv`)
-    -   Between-group standard deviation (`bgsd`)
-    -   Coefficient of variation (`covar`)
-###   Mean difference measures (non-ordered dimensions)
-    -   Mean difference from mean - unweighted and weighted (`mdmu` and `mdmw`)
-    -   Mean difference from best-performing subgroup - unweighted and weighted (`mdbu` and `mdbw`)
-    -   Mean difference from reference subgroup - unweighted and weighted (`mdru` and `mdrw`)
-    -   Index of disparity - unweighted and weighted (`idisu` and `idisw`)
-###   Disproportionality measures (non-ordered dimensions)
-    -   Theil index (`ti`)
-    -   Mean log deviation (`mld`)
-###  Impact measures
-    -   Population attributable risk (`parisk`)
-    -   Population attributable fraction (`paf`)
-    
+### Simple measures
+
+-   Difference (`d`)
+-   Ratio (`r`)
+
+### Disproportionality measures (ordered dimensions)
+
+-   Absolute concentration index (`aci`)
+-   Relative concentration index (`rci`)
+
+### Regression-based measures (ordered dimensions)
+
+-   Slope index of inequality (`sii`)
+-   Relative index of inequality (`rii`)
+
+### Variance measures (non-ordered dimensions)
+
+-   Between-group variance (`bgv`)
+-   Between-group standard deviation (`bgsd`)
+-   Coefficient of variation (`covar`)
+
+### Mean difference measures (non-ordered dimensions)
+
+-   Mean difference from mean - unweighted and weighted (`mdmu` and `mdmw`)
+-   Mean difference from best-performing subgroup - unweighted and weighted (`mdbu` and `mdbw`)
+-   Mean difference from reference subgroup - unweighted and weighted (`mdru` and `mdrw`)
+-   Index of disparity - unweighted and weighted (`idisu` and `idisw`)
+
+### Disproportionality measures (non-ordered dimensions)
+
+-   Theil index (`ti`)
+-   Mean log deviation (`mld`)
+
+### Impact measures
+
+-   Population attributable risk (`parisk`)
+-   Population attributable fraction (`paf`)
+
 # Package data
 
 The `healthequal` package comes with sample data for users to be able to test the package functions. The `OrderedSample` and `NonorderedSample` data contain data disaggregated by economic status and subnational region, respectively, for a single indicator.
 
 ### Ordered and Nonordered data
+
 ``` r
 data(OrderedSample)
 head(OrderedSample)
 ```
 
-```r
+``` r
 data(NonorderedSample)
 head(NonorderedSample)
 ```
+
 ### Disagregated data
 
 The `OrderedSampleMultipleind` and `OrderedSampleMultipleind` data contain disaggregated data by economic status and subnational region, respectively, for two indicators.
 
-```r
+``` r
 data(OrderedSampleMultipleind)
 head(OrderedSampleMultipleind)
 ```
 
-```r
+``` r
 data(NonorderedSampleMultipleind)
 head(NonorderedSampleMultipleind)
 ```
@@ -100,18 +116,14 @@ head(NonorderedSampleMultipleind)
 
 For information about the datasets, type the following commands, which will display the corresponding dataset help file:
 
-```r
+``` r
 ?healthequal::OrderedSample
 ?healthequal::NonorderedSample
 ?healthequal::OrderedSampleMultipleind
 ?healthequal::NonorderedSampleMultipleind
 ?healthequal::IndividualSample
 ```
-    
 
 # References:
 
-Schlotheuber, A., & Hosseinpoor, A. R. (2022).
-Summary measures of health inequality: A review of existing
-measures and their application. International Journal of
-Environmental Research and Public Health, 19 (6), 3697.
+Schlotheuber, A., & Hosseinpoor, A. R. (2022). Summary measures of health inequality: A review of existing measures and their application. International Journal of Environmental Research and Public Health, 19 (6), 3697.

inst/CITATION

@@ -4,5 +4,5 @@ bibentry(
   author   = "Daniel A. Antiporta, Patricia Menendez, Katherine Kirkby, and Ahmad Reza Hosseinpoor",
   year     = 2024,
   institution = "World Health Organization",
-  note = "R package version 0.0.1"
+  note = "R package version 1.0.0"
 )