From 53e5f277b6aeec8f77483dd44ccccbc568cede0e Mon Sep 17 00:00:00 2001 From: dhersz Date: Thu, 21 Sep 2023 12:52:33 +0000 Subject: [PATCH] Built site for accessibility: 1.2.0.9000@5111064 --- dev/LICENSE-text.html | 2 +- dev/apple-touch-icon-120x120.png | Bin 13315 -> 13315 bytes dev/apple-touch-icon-152x152.png | Bin 19182 -> 19182 bytes dev/apple-touch-icon-180x180.png | Bin 24937 -> 24937 bytes dev/apple-touch-icon-60x60.png | Bin 4515 -> 4515 bytes dev/apple-touch-icon-76x76.png | Bin 6524 -> 6524 bytes dev/apple-touch-icon.png | Bin 24937 -> 24937 bytes dev/articles/accessibility.html | 2 +- dev/articles/decay_functions.html | 6 +- dev/articles/index.html | 2 +- dev/articles/inequality_and_poverty.html | 94 ++++++++++++++++++++- dev/authors.html | 6 +- dev/favicon-16x16.png | Bin 1145 -> 1145 bytes dev/favicon-32x32.png | Bin 1906 -> 1906 bytes dev/index.html | 2 +- dev/news/index.html | 17 +++- dev/pkgdown.yml | 2 +- dev/reference/accessibility.html | 2 +- dev/reference/balancing_cost.html | 2 +- dev/reference/concentration_index.html | 2 +- dev/reference/cost_to_closest.html | 2 +- dev/reference/cumulative_cutoff.html | 2 +- dev/reference/cumulative_interval.html | 2 +- dev/reference/decay_binary.html | 2 +- dev/reference/decay_exponential.html | 2 +- dev/reference/decay_linear.html | 2 +- dev/reference/decay_power.html | 2 +- dev/reference/decay_stepped.html | 2 +- dev/reference/fgt_poverty.html | 2 +- dev/reference/floating_catchment_area.html | 8 +- dev/reference/gini_index.html | 2 +- dev/reference/gravity.html | 8 +- dev/reference/index.html | 2 +- dev/reference/palma_ratio.html | 2 +- dev/reference/spatial_availability.html | 8 +- dev/reference/theil_t.html | 6 +- 36 files changed, 144 insertions(+), 49 deletions(-) diff --git a/dev/LICENSE-text.html b/dev/LICENSE-text.html index ca397ca..c253df4 100644 --- a/dev/LICENSE-text.html +++ b/dev/LICENSE-text.html @@ -17,7 +17,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 diff --git a/dev/apple-touch-icon-120x120.png b/dev/apple-touch-icon-120x120.png index a4a4cad56dea152cae3c603627bcd794bdcf2e84..166b46f6b51df7c02c6236313b91af113bfc08ca 100644 GIT binary patch delta 93 zcmZq9XwH~W#UaXLEaPI-61%bKtdXl>h@p{{siBpTg|>l#m4QL?|K2191_sp<*NBpo j#FA92-29Zxv`Pje10!Qy14~^abPb;tnckZ`#W)`TG`t*e delta 93 zcmZq9XwH~W#UUcXpm&K~)nQ}PStD125F-OC0|P4)Gi@MgU|^YVd6a>HLAAs+q9i4; hB-JW6KP5A*lEKKp$XM6FQr8GwgNIRL<>V>G`2g(X8ZQ6< diff --git a/dev/apple-touch-icon-152x152.png b/dev/apple-touch-icon-152x152.png index 289fcb2ec4f2eff84038416ac6b296875412e0be..fb78720d2632e7ebc8b0cb100ca33016c8a594e2 100644 GIT binary patch delta 71 zcmaDimGRwF#tBs%qCCd3#->|NZ*1D(DPkC6Xk=w-Xk}!nZD3$!V4&L3c5Sksmn?=v M$W^)!ag8WR jNi0dV%FR#7OsixtGB7gMHL%n*Lf5cpu3z(H6Ty4{5Z4+tPBiFxBu;)d`ChSLxSa% KtNCPJ$$S7Q6BS?p delta 69 zcmexk^v7sI6^DojgN_ZSOU}k7Hwh7g5F-OC0|P4)6Kx=AV6g6k#+%7^BxErp?ysE? JFqu~}9{}FL6zKo} diff --git a/dev/apple-touch-icon.png b/dev/apple-touch-icon.png index 94da7e4f460322e17094edeba7d5bdbe47f22071..79d1af743b8fcce3ba56a072659ba5f11b1dddc6 100644 GIT binary patch delta 71 zcmaEPi1Fni#tBs%qCCd(cdf5J-`HfFAYvF|Xk=w-Xk~1uZD3$!U~uc~3H`|@6J#+Y NR!=CHJo#5bJ^-iD8AkvB delta 71 zcmaEPi1Fni#tBs%A|edN8yP)kZfr765HScbGO#i*urf8&29gE_21)E!C!b7^#gK5c L-=8`8S3*7jE}Iq| diff --git a/dev/articles/accessibility.html b/dev/articles/accessibility.html index f04de48..92e2e56 100644 --- a/dev/articles/accessibility.html +++ b/dev/articles/accessibility.html @@ -41,7 +41,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 diff --git a/dev/articles/decay_functions.html b/dev/articles/decay_functions.html index caa12c0..4439e57 100644 --- a/dev/articles/decay_functions.html +++ b/dev/articles/decay_functions.html @@ -41,7 +41,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 @@ -402,8 +402,8 @@

Using a custom decay function#> names(weights_list) <- decay_value #> return(weights_list) #> } -#> <bytecode: 0x5560023f0cb8> -#> <environment: 0x5560036fa0b0> +#> <bytecode: 0x5623d551e970> +#> <environment: 0x5623d6789160>

What if we want our custom function to take many decay parameters as inputs, just like the built-in decay functions? In this case, our output function has to return a list of numeric diff --git a/dev/articles/index.html b/dev/articles/index.html index 02f92b4..a782c01 100644 --- a/dev/articles/index.html +++ b/dev/articles/index.html @@ -17,7 +17,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 diff --git a/dev/articles/inequality_and_poverty.html b/dev/articles/inequality_and_poverty.html index 51c0b4a..1b51507 100644 --- a/dev/articles/inequality_and_poverty.html +++ b/dev/articles/inequality_and_poverty.html @@ -41,7 +41,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 @@ -241,6 +241,94 @@

Concentration Index#> 1: 0.3346494
+

Theil T +

+

theil_t() calculates the Theil T Index of a given +accessibility distribution. Values range from 0 (when all individuals +have exactly the same accessibility levels) to the natural log of +n, in which n is the number of individuals in the +accessibility dataset.

+

If the individuals can be classified into mutually exclusive and +completely exhaustive groups (i.e. into groups that do not overlap and +cover the entire population), the index can be decomposed into a +between- and a within-groups inequality component. The function includes +a socioeconomic_groups parameter to indicate which variable +from the sociodemographic dataset should be used identify the +socioeconomic groups used to calculate these components.

+

Please note that the output theil_t() varies based on +the value of socioeconomic_groups. If NULL +(the default), the between- and within-groups components are not +calculated, and the function returns a data frame containing only the +total aggregate inequality for the returned area. If +socioeconomic_groups is not NULL, however, the +function returns a list containing three dataframes: one summarizing the +total inequality and the between- and within-groups components, one +listing the contribution of each group to the between-groups component +and another listing the contribution of each group to the within-groups +component. Both behaviors are shown below.

+
+theil_without_groups <- theil_t(
+  access,
+  sociodemographic_data = land_use_data,
+  opportunity = "jobs",
+  population = "population"
+)
+theil_without_groups
+#>      theil_t
+#> 1: 0.3616631
+
+# some cells are classified as in the decile NA because their income per capita
+# is NaN, as they don't have any population. we filter these cells from our
+# accessibility data, otherwise the output would include NA values (note that
+# subsetting the data like this doesn't affect the assumption that groups are
+# completely exhaustive, because cells with NA income decile don't have any
+# population)
+
+na_decile_ids <- land_use_data[is.na(land_use_data$income_decile), ]$id
+no_na_access <- access[! access$id %in% na_decile_ids, ]
+sociodem_data <- land_use_data[! land_use_data$id %in% na_decile_ids, ]
+
+theil_with_groups <- theil_t(
+  no_na_access,
+  sociodemographic_data = sociodem_data,
+  opportunity = "jobs",
+  population = "population",
+  socioeconomic_groups = "income_decile"
+)
+theil_with_groups
+#> $summary
+#>        component     value share_of_total
+#> 1: between_group 0.1280753      0.3541287
+#> 2:  within_group 0.2335878      0.6458713
+#> 3:         total 0.3616631      1.0000000
+#> 
+#> $within_group_component
+#>     income_decile       value share_of_component
+#>  1:             1 0.009181454         0.03930622
+#>  2:             2 0.011413697         0.04886255
+#>  3:             3 0.019320622         0.08271246
+#>  4:             4 0.023606928         0.10106232
+#>  5:             5 0.031470429         0.13472633
+#>  6:             6 0.023539337         0.10077296
+#>  7:             7 0.033329635         0.14268567
+#>  8:             8 0.032585905         0.13950173
+#>  9:             9 0.020299031         0.08690107
+#> 10:            10 0.028840780         0.12346868
+#> 
+#> $between_group_component
+#>     income_decile        value
+#>  1:             1 -0.037573783
+#>  2:             2 -0.036276865
+#>  3:             3 -0.031829123
+#>  4:             4 -0.021600054
+#>  5:             5 -0.009938574
+#>  6:             6 -0.004401762
+#>  7:             7  0.025936879
+#>  8:             8  0.042240708
+#>  9:             9  0.075742415
+#> 10:            10  0.125775443
+
+

Foster-Greer-Thorbecke (FGT) poverty measures

fgt_poverty() calculates the FGT metrics, a family of @@ -266,11 +354,11 @@

Foster-Greer-Thorbecke (FGT

This function includes an additional poverty_line parameter, used to define the poverty line below which individuals are considered to be in accessibility poverty.

-
+
 poverty <- fgt_poverty(
   access,
-  opportunity = "jobs",
   sociodemographic_data = land_use_data,
+  opportunity = "jobs",
   population = "population",
   poverty_line = 95368
 )
diff --git a/dev/authors.html b/dev/authors.html
index 88f2d9c..8e17b16 100644
--- a/dev/authors.html
+++ b/dev/authors.html
@@ -17,7 +17,7 @@
       
       
         accessibility
-        1.1.0.9000
+        1.2.0.9000
       
     

 
@@ -87,13 +87,13 @@ 
Citation

 
     
Pereira R, Herszenhut D (2023).
 accessibility: Transport Accessibility Measures.
-R package version 1.1.0.9000, https://github.com/ipeaGIT/accessibility. 
+R package version 1.2.0.9000, https://github.com/ipeaGIT/accessibility. 
 

     
@Manual{,
   title = {accessibility: Transport Accessibility Measures},
   author = {Rafael H. M. Pereira and Daniel Herszenhut},
   year = {2023},
-  note = {R package version 1.1.0.9000},
+  note = {R package version 1.2.0.9000},
   url = {https://github.com/ipeaGIT/accessibility},
 }

 
diff --git a/dev/favicon-16x16.png b/dev/favicon-16x16.png
index f58cd09c6ca30f3d751636a6aebc7bc7c517d910..53d4d6f973cb9ef80488fcd1fd4ec73bbf440706 100644
GIT binary patch
delta 71
zcmey#@snf2Dkct59%Gdp1DnH}H!%q_iWr6%8d;edS{a*Z8yHv_7|3URTR8b9vn+;0
Mp1GgwWG8EzE)

diff --git a/dev/favicon-32x32.png b/dev/favicon-32x32.png
index f217451e6464cbe4b43281a1723a878c23180a6c..7e5678d144f8889300e8cbca98150d24eff304e4 100644
GIT binary patch
delta 93
zcmeyw_la*p6^AH~v8uE=Pw2)b8#Y(N5JMv?Q$s6bb8Q0yD+7a_vVTPx7#LJbTq8ty&^4TJa9uf>nLQr>x2G9P

delta 93
zcmeyw_la*p6^DojgVl++EOm|0HC$Q#Yu99E_Iv
       
         accessibility
-        1.1.0.9000
+        1.2.0.9000
diff --git a/dev/news/index.html b/dev/news/index.html index c143432..db213d9 100644 --- a/dev/news/index.html +++ b/dev/news/index.html @@ -17,7 +17,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000

@@ -67,14 +67,25 @@

Changelog

accessibility (development version)

New features

-
+

Bug fixes

Notes

+ +
+

accessibility 1.2.02023-09-21

+
+

New features

+
+
+

Notes

+
  • Various documentation tweaks.
    • +
  • Testing performance has greatly improved.
    • +

accessibility 1.1.02023-06-22

diff --git a/dev/pkgdown.yml b/dev/pkgdown.yml index fa10e00..2fee962 100644 --- a/dev/pkgdown.yml +++ b/dev/pkgdown.yml @@ -5,5 +5,5 @@ articles: accessibility: accessibility.html decay_functions: decay_functions.html inequality_and_poverty: inequality_and_poverty.html -last_built: 2023-09-20T20:01Z +last_built: 2023-09-21T12:51Z diff --git a/dev/reference/accessibility.html b/dev/reference/accessibility.html index 34e14a9..2505082 100644 --- a/dev/reference/accessibility.html +++ b/dev/reference/accessibility.html @@ -24,7 +24,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000
diff --git a/dev/reference/balancing_cost.html b/dev/reference/balancing_cost.html index 6bc42dd..6e5efd8 100644 --- a/dev/reference/balancing_cost.html +++ b/dev/reference/balancing_cost.html @@ -24,7 +24,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 diff --git a/dev/reference/concentration_index.html b/dev/reference/concentration_index.html index b3352a8..f8ebafa 100644 --- a/dev/reference/concentration_index.html +++ b/dev/reference/concentration_index.html @@ -26,7 +26,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 diff --git a/dev/reference/cost_to_closest.html b/dev/reference/cost_to_closest.html index b2c6e62..864b293 100644 --- a/dev/reference/cost_to_closest.html +++ b/dev/reference/cost_to_closest.html @@ -19,7 +19,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 diff --git a/dev/reference/cumulative_cutoff.html b/dev/reference/cumulative_cutoff.html index c2de937..1e6e1be 100644 --- a/dev/reference/cumulative_cutoff.html +++ b/dev/reference/cumulative_cutoff.html @@ -20,7 +20,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 diff --git a/dev/reference/cumulative_interval.html b/dev/reference/cumulative_interval.html index d047448..320e21c 100644 --- a/dev/reference/cumulative_interval.html +++ b/dev/reference/cumulative_interval.html @@ -24,7 +24,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 diff --git a/dev/reference/decay_binary.html b/dev/reference/decay_binary.html index 5d422ab..7b79649 100644 --- a/dev/reference/decay_binary.html +++ b/dev/reference/decay_binary.html @@ -21,7 +21,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 diff --git a/dev/reference/decay_exponential.html b/dev/reference/decay_exponential.html index 2be11b2..e1657ea 100644 --- a/dev/reference/decay_exponential.html +++ b/dev/reference/decay_exponential.html @@ -20,7 +20,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 diff --git a/dev/reference/decay_linear.html b/dev/reference/decay_linear.html index 13dd7ea..cedcc5b 100644 --- a/dev/reference/decay_linear.html +++ b/dev/reference/decay_linear.html @@ -20,7 +20,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 diff --git a/dev/reference/decay_power.html b/dev/reference/decay_power.html index d3bd2aa..814248e 100644 --- a/dev/reference/decay_power.html +++ b/dev/reference/decay_power.html @@ -20,7 +20,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 diff --git a/dev/reference/decay_stepped.html b/dev/reference/decay_stepped.html index 4991676..86ed0e0 100644 --- a/dev/reference/decay_stepped.html +++ b/dev/reference/decay_stepped.html @@ -20,7 +20,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 diff --git a/dev/reference/fgt_poverty.html b/dev/reference/fgt_poverty.html index 7b4d4a4..157a228 100644 --- a/dev/reference/fgt_poverty.html +++ b/dev/reference/fgt_poverty.html @@ -24,7 +24,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 diff --git a/dev/reference/floating_catchment_area.html b/dev/reference/floating_catchment_area.html index 8420648..d4b117e 100644 --- a/dev/reference/floating_catchment_area.html +++ b/dev/reference/floating_catchment_area.html @@ -21,7 +21,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 @@ -133,9 +133,9 @@

Arguments

impedance factor used to weight opportunities. This function should take a numeric vector and also return a numeric vector as output, with the same length as the input. For convenience, the package currently includes -the following functions: decay_binary(), decay_exponential() and -decay_power(). See the documentation of each decay function for more -details.

+the following functions: decay_binary(), decay_exponential(), +decay_power() and decay_stepped(). See the documentation of each decay +function for more details.

group_by
diff --git a/dev/reference/gini_index.html b/dev/reference/gini_index.html index 10a051d..f8f9171 100644 --- a/dev/reference/gini_index.html +++ b/dev/reference/gini_index.html @@ -17,7 +17,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 diff --git a/dev/reference/gravity.html b/dev/reference/gravity.html index c8e05e6..bd54785 100644 --- a/dev/reference/gravity.html +++ b/dev/reference/gravity.html @@ -20,7 +20,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 @@ -118,9 +118,9 @@

Arguments

impedance factor used to weight opportunities. This function should take a numeric vector and also return a numeric vector as output, with the same length as the input. For convenience, the package currently includes -the following functions: decay_binary(), decay_exponential() and -decay_power(). See the documentation of each decay function for more -details.

+the following functions: decay_binary(), decay_exponential(), +decay_power() and decay_stepped(). See the documentation of each decay +function for more details.

group_by
diff --git a/dev/reference/index.html b/dev/reference/index.html index da68512..9ac54a8 100644 --- a/dev/reference/index.html +++ b/dev/reference/index.html @@ -17,7 +17,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 diff --git a/dev/reference/palma_ratio.html b/dev/reference/palma_ratio.html index b229e52..17af7d5 100644 --- a/dev/reference/palma_ratio.html +++ b/dev/reference/palma_ratio.html @@ -21,7 +21,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 diff --git a/dev/reference/spatial_availability.html b/dev/reference/spatial_availability.html index 1db2095..3e61185 100644 --- a/dev/reference/spatial_availability.html +++ b/dev/reference/spatial_availability.html @@ -24,7 +24,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 @@ -133,9 +133,9 @@

Arguments

impedance factor used to weight opportunities. This function should take a numeric vector and also return a numeric vector as output, with the same length as the input. For convenience, the package currently includes -the following functions: decay_binary(), decay_exponential() and -decay_power(). See the documentation of each decay function for more -details.

+the following functions: decay_binary(), decay_exponential(), +decay_power() and decay_stepped(). See the documentation of each decay +function for more details.

alpha
diff --git a/dev/reference/theil_t.html b/dev/reference/theil_t.html index 97bc70f..2e46043 100644 --- a/dev/reference/theil_t.html +++ b/dev/reference/theil_t.html @@ -23,7 +23,7 @@ accessibility - 1.1.0.9000 + 1.2.0.9000 @@ -146,10 +146,6 @@

Value

within-groups components, one listing the contribution of each group to the between-groups component and another listing the contribution of each group to the within-groups component.

- -
-

References

-

There are no references for Rd macro \insertAllCites on this help page.

See also