diff --git a/R/write_citation_example.R b/R/write_citation_example.R deleted file mode 100644 index f09e6fd..0000000 --- a/R/write_citation_example.R +++ /dev/null @@ -1,31 +0,0 @@ - - - -library(cffr) - -packageVersion("cffr") - -# Download a DESCRIPTION file -tmp <- file.path(tempdir(), "DESCRIPTION") - -download.file("https://raw.githubusercontent.com/openwashdata/fsmglobal/main/DESCRIPTION", - tmp, - quiet = TRUE -) - -# creates CFF with all author roles & date-released to add "year"? -mod_cff <- cffr::cff_create(tmp, dependencies = FALSE, - authors_roles = c("aut", "cre", "ctb", "fnd"), - keys = list("date-released" = Sys.Date())) - -# writes the CFF file -outcff <- tempfile(fileext = ".cff") -cff_write(mod_cff, outfile = outcff) - -# Now write a CITATION file from the CITATION.cff file -# Use inst/CITATION instead (the default if not provided) -tmpcit <- file.path(tempdir(), "CITATION") - -write_citation(outcff, tmpcit) - -cat(readLines(tmpcit), sep = "\n") diff --git a/README.Rmd b/README.Rmd index 1300326..3ccc24c 100644 --- a/README.Rmd +++ b/README.Rmd @@ -34,7 +34,7 @@ This data was first published as part of a journal article by [@greene2021] and ## Installation -You can install the development version of fsmglobal from [GitHub](https://github.com/) with: +You can install fsmglobal from [GitHub](https://github.com/) with: ``` r # install.packages("devtools") @@ -129,7 +129,6 @@ Please cite using: ```{r} citation("fsmglobal") -s``` - +``` ## References diff --git a/_pkgdown.yml b/_pkgdown.yml index 3bfecfd..183f179 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -4,7 +4,7 @@ template: bootstrap: 5 includes: in_header: | - + home: links: diff --git a/data/fsmglobal.rda b/data/fsmglobal.rda index bdd1fb5..2af47dd 100644 Binary files a/data/fsmglobal.rda and b/data/fsmglobal.rda differ diff --git a/docs/404.html b/docs/404.html index 86fe527..3beec35 100644 --- a/docs/404.html +++ b/docs/404.html @@ -10,11 +10,11 @@ - + + Skip to contents @@ -72,7 +72,7 @@ diff --git a/docs/LICENSE.html b/docs/LICENSE.html index 2838118..78fbac4 100644 --- a/docs/LICENSE.html +++ b/docs/LICENSE.html @@ -1,8 +1,8 @@ -NA • fsmglobalNA • fsmglobal + Skip to contents @@ -47,36 +47,36 @@

Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.

Using Creative Commons Public Licenses

Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.

-
 Considerations for licensors: Our public licenses are
- intended for use by those authorized to give the public
- permission to use material in ways otherwise restricted by
- copyright and certain other rights. Our licenses are
- irrevocable. Licensors should read and understand the terms
- and conditions of the license they choose before applying it.
- Licensors should also secure all rights necessary before
- applying our licenses so that the public can reuse the
- material as expected. Licensors should clearly mark any
- material not subject to the license. This includes other CC-
- licensed material, or material used under an exception or
- limitation to copyright. More considerations for licensors:
-wiki.creativecommons.org/Considerations_for_licensors
-
- Considerations for the public: By using one of our public
- licenses, a licensor grants the public permission to use the
- licensed material under specified terms and conditions. If
- the licensor's permission is not necessary for any reason--for
- example, because of any applicable exception or limitation to
- copyright--then that use is not regulated by the license. Our
- licenses grant only permissions under copyright and certain
- other rights that a licensor has authority to grant. Use of
- the licensed material may still be restricted for other
- reasons, including because others have copyright or other
- rights in the material. A licensor may make special requests,
- such as asking that all changes be marked or described.
- Although not required by our licenses, you are encouraged to
- respect those requests where reasonable. More considerations
- for the public: 
-wiki.creativecommons.org/Considerations_for_licensees
+
 Considerations for licensors: Our public licenses are
+ intended for use by those authorized to give the public
+ permission to use material in ways otherwise restricted by
+ copyright and certain other rights. Our licenses are
+ irrevocable. Licensors should read and understand the terms
+ and conditions of the license they choose before applying it.
+ Licensors should also secure all rights necessary before
+ applying our licenses so that the public can reuse the
+ material as expected. Licensors should clearly mark any
+ material not subject to the license. This includes other CC-
+ licensed material, or material used under an exception or
+ limitation to copyright. More considerations for licensors:
+wiki.creativecommons.org/Considerations_for_licensors
+
+ Considerations for the public: By using one of our public
+ licenses, a licensor grants the public permission to use the
+ licensed material under specified terms and conditions. If
+ the licensor's permission is not necessary for any reason--for
+ example, because of any applicable exception or limitation to
+ copyright--then that use is not regulated by the license. Our
+ licenses grant only permissions under copyright and certain
+ other rights that a licensor has authority to grant. Use of
+ the licensed material may still be restricted for other
+ reasons, including because others have copyright or other
+ rights in the material. A licensor may make special requests,
+ such as asking that all changes be marked or described.
+ Although not required by our licenses, you are encouraged to
+ respect those requests where reasonable. More considerations
+ for the public: 
+wiki.creativecommons.org/Considerations_for_licensees

=======================================================================

Creative Commons Attribution 4.0 International Public License

By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License (“Public License”). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.

@@ -181,7 +181,7 @@ diff --git a/docs/articles/index.html b/docs/articles/index.html index b0cc6be..9fe86c5 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -1,8 +1,8 @@ -Articles • fsmglobalArticles • fsmglobal + Skip to contents @@ -55,7 +55,7 @@

All vignettes

diff --git a/docs/authors.html b/docs/authors.html index b9e0f6c..e2cbf76 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -1,8 +1,8 @@ -Authors and Citation • fsmglobalAuthors and Citation • fsmglobal + Skip to contents @@ -52,7 +52,7 @@

Authors

  • -

    Tate W. Rogers. Author. +

    Tate W. Rogers. Author.

  • @@ -73,14 +73,18 @@

    Authors

    Citation

    -

    Greene N, Henessy S, Rogers T, Tsai J, de los Reyes III F, Schöbitz L (????). -“fsmglobal: Global Faecal Sludge Emptying Services Demand.” +

    Greene N, Hennessy S, Rogers TW, Tsai J, III FLdlR, Schöbitz L (2023). +“fsmglobal. Global Faecal Sludge Emptying Services Demand.”

    -
    @Misc{greenehenessy,
    -  title = {fsmglobal: Global Faecal Sludge Emptying Services Demand},
    -  author = {Nicola Greene and Sarah Henessy and Tate W. Rogers and Jocelyn Tsai and Francis L. {de los Reyes III} and Lars Schöbitz},
    -  abstract = {Global faecal sludge emptying demand data for 175 countries. Demand is quantified by population size receiving one of four emptying methods (mechanized, non-mechanized, unemptiable, no facility). The demand is disaggregated by rural and urban percentages of population.},
    +      
    @Misc{R-fsmglobal,
    +  title = {fsmglobal. Global Faecal Sludge Emptying Services Demand},
    +  author = {Nicola Greene and Sarah Hennessy and Tate W. Rogers and Jocelyn Tsai and Francis L. de los Reyes III and Lars Schöbitz},
    +  abstract = {Global faecal sludge emptying demand data for 175 countries. Demand
    +    is quantified by population size receiving one of four emptying methods
    +    (mechanized, non-mechanized, unemptiable, no facility). The demand is 
    +    disaggregated by rural and urban percentages of population. },
       version = {0.0.0.9000},
    +  year = {2023},
     }
     tbl_emptying_demand_global |> 
    -  janitor::adorn_totals() |>
    +  janitor::adorn_totals() |>
       
       # use gt R package to prepare a table
       gt(rowname_col = "emptying_method") |>
    @@ -196,14 +196,23 @@ 

    Examples fmt_number(columns = "sum_population_emptying_method", decimals = 0) |> fmt_percent(columns = "percent", decimals = 0, scale_values = FALSE) |> cols_label(sum_population_emptying_method = "population")

    -
    - - - - +
    + + - + - - + - + +
    Demand for faecal sludge emptying services
    summarised for 175 countries
    @@ -629,7 +606,8 @@

    Examples percent

    @@ -701,7 +679,6 @@

    CitationPlease cite using:

     citation("fsmglobal")
    -#> 
     #> To cite package 'fsmglobal' in publications use:
     #> 
     #>   Greene N, Henessy S, Rogers T, Tsai J, de los Reyes III F, Schöbitz L
    @@ -746,7 +723,7 @@ 

    Developers

  • So who does the work?
  • Nicola Greene
    Author
  • Sarah Hennessy
    Author
  • -
  • Tate W. Rogers
    Author
  • +
  • Tate W. Rogers
    Author
  • Jocelyn Tsai
    Author
  • Francis L. de los Reyes III
    Author
  • Thanks all!
  • @@ -754,12 +731,7 @@

    Developers

    -
    -

    Dev status

    -
      -
    • R-CMD-check
    • -
    -
    +

    Funding

    @@ -779,7 +751,7 @@

    Funding

    diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 6638a5b..2545840 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,9 +1,9 @@ -pandoc: 2.19.2 -pkgdown: 2.0.6 +pandoc: 3.1.6 +pkgdown: 2.0.7 pkgdown_sha: ~ articles: examples: examples.html -last_built: 2023-05-03T09:10Z +last_built: 2023-08-02T11:46Z urls: reference: https://openwashdata.github.io/fsmglobal/reference article: https://openwashdata.github.io/fsmglobal/articles diff --git a/docs/reference/fsmglobal-package.html b/docs/reference/fsmglobal-package.html index fc8eec4..4e11d4e 100644 --- a/docs/reference/fsmglobal-package.html +++ b/docs/reference/fsmglobal-package.html @@ -1,8 +1,8 @@ -fsmglobal: Global Faecal Sludge Emptying Services Demand — fsmglobal-package • fsmglobalfsmglobal: Global Faecal Sludge Emptying Services Demand — fsmglobal-package • fsmglobal + Skip to contents @@ -51,8 +51,8 @@

    Author

    Maintainer: Lars Schöbitz lschoebitz@ethz.ch (ORCID)

    Authors:

    @@ -65,7 +65,7 @@

    Author< diff --git a/docs/reference/fsmglobal.html b/docs/reference/fsmglobal.html index 615a0bd..5e051fc 100644 --- a/docs/reference/fsmglobal.html +++ b/docs/reference/fsmglobal.html @@ -1,8 +1,8 @@ -fsmglobal — fsmglobal • fsmglobalfsmglobal — fsmglobal • fsmglobal + Skip to contents @@ -96,7 +96,7 @@

    Source< diff --git a/docs/reference/index.html b/docs/reference/index.html index 45597cd..fd947f3 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -1,8 +1,8 @@ -Function reference • fsmglobalFunction reference • fsmglobal + Skip to contents @@ -65,7 +65,7 @@

    All functions -

    Site built with pkgdown 2.0.6.

    +

    Site built with pkgdown 2.0.7.

    diff --git a/inst/CITATION.bk1 b/inst/CITATION.bk1 deleted file mode 100644 index c633818..0000000 --- a/inst/CITATION.bk1 +++ /dev/null @@ -1,18 +0,0 @@ - -bibentry(bibtype = "Misc", - key = "greenehenessy", - title = "fsmglobal: Global Faecal Sludge Emptying Services Demand", - author = c(person(given = "Nicola", - family = "Greene"), - person(given = "Sarah", - family = "Henessy"), - person(given = "Tate W.", - family = "Rogers"), - person(given = "Jocelyn", - family = "Tsai"), - person(given = "Francis L.", - family = "de los Reyes III"), - person(given = "Lars", - family = "Schöbitz")), - abstract = "Global faecal sludge emptying demand data for 175 countries. Demand is quantified by population size receiving one of four emptying methods (mechanized, non-mechanized, unemptiable, no facility). The demand is disaggregated by rural and urban percentages of population.", - version = "0.0.0.9000") diff --git a/inst/extdata/fsmglobal.csv b/inst/extdata/fsmglobal.csv index 495c23d..4ae4ce7 100644 --- a/inst/extdata/fsmglobal.csv +++ b/inst/extdata/fsmglobal.csv @@ -156,7 +156,7 @@ MRT,Mauritania,mechanized,4420182.997007927,1049154.6965088816,198560.4532312582 MUS,Mauritius,mechanized,1265137.0977841427,722242.2882947129,202287.51539061608,0.5708806496621615,0.27267659581499853,0.7273234041850015 MYT,Mayotte,mechanized,NA,0,0,NA,NA,NA MOZ,Mozambique,mechanized,29668814.879078306,3871742.1453944114,798471.8399274102,0.13049871257664106,0.9015090891660513,0.09849091083394863 -"NAM",Namibia,mechanized,2533795.1763287843,154172.18382441055,31057.567974044803,0.06084634830183496,0.38782682522683315,0.6121731747731668 +NAM,Namibia,mechanized,2533795.1763287843,154172.18382441055,31057.567974044803,0.06084634830183496,0.38782682522683315,0.6121731747731668 NER,Niger,mechanized,21477381.84057851,1993897.3397108524,241748.1446252432,0.09283707644214166,0.8061459453988503,0.19385405460114968 NGA,Nigeria,mechanized,190886295.59758583,8652232.918995595,1338835.952241502,0.0453266322336501,0.7700470884402356,0.22995291155976436 REU,Réunion,mechanized,876561.9461389979,0,0,0,NA,NA @@ -331,7 +331,7 @@ MRT,Mauritania,non-mechanized,4420182.997007927,1310377.4196311184,244110.562562 MUS,Mauritius,non-mechanized,1265137.0977841427,242244.773895287,67848.52401358119,0.19147709313051758,0.2719004898848074,0.7280995101151926 MYT,Mayotte,non-mechanized,NA,0,0,NA,NA,NA MOZ,Mozambique,non-mechanized,29668814.879078306,5968370.026575589,1248613.840012745,0.20116644533665992,0.45984083789529295,0.540159162104707 -"NAM",Namibia,non-mechanized,2533795.1763287843,131378.48722558946,27021.799597861365,0.05185047649192534,0.1672198531359863,0.8327801468640136 +NAM,Namibia,non-mechanized,2533795.1763287843,131378.48722558946,27021.799597861365,0.05185047649192534,0.1672198531359863,0.8327801468640136 NER,Niger,non-mechanized,21477381.84057851,2866806.645259147,350990.31564447616,0.1334802661953291,0.34132297845712894,0.6586770215428711 NGA,Nigeria,non-mechanized,190886295.59758583,86143429.8587544,13626534.986889526,0.45128137454328526,0.628784532253983,0.37121546774601705 REU,Réunion,non-mechanized,876561.9461389979,0,0,0,NA,NA @@ -506,7 +506,7 @@ MRT,Mauritania,unemptiable,4420182.997007927,532608.14103,95460.65008597451,0.12 MUS,Mauritius,unemptiable,1265137.0977841427,5084.93566,1424.070680369899,0.00401927638427973,0.0987980209763362,0.9012019790236637 MYT,Mayotte,unemptiable,NA,0,NA,NA,NA,NA MOZ,Mozambique,unemptiable,29668814.879078306,11433676.102869999,2406062.2602699567,0.38537690667694097,0.2770149822334889,0.7229850177665111 -"NAM",Namibia,unemptiable,2533795.1763287843,110329.81558,22088.79227016388,0.0435433047669847,0.4524890576274087,0.5475109423725913 +NAM,Namibia,unemptiable,2533795.1763287843,110329.81558,22088.79227016388,0.0435433047669847,0.4524890576274087,0.5475109423725913 NER,Niger,unemptiable,21477381.84057851,1900119.62445,233185.37756212824,0.08847072881388128,0.22832562990636923,0.7716743700936308 NGA,Nigeria,unemptiable,190886295.59758583,39165443.06872,6543304.282346125,0.205176819771735,0.26454471308726135,0.7354552869127388 REU,Réunion,unemptiable,876561.9461389979,0,NA,0,NA,NA @@ -681,7 +681,7 @@ MRT,Mauritania,no facility,4420182.997007927,1411431.18558,291370.71543145657,0. MUS,Mauritius,no facility,1265137.0977841427,1653.3067,475.7309681195513,0.0013068201880220944,0,1 MYT,Mayotte,no facility,NA,0,0,NA,NA,NA MOZ,Mozambique,no facility,29668814.879078306,8131054.59118,1862203.1377131483,0.2740606466527186,0.1048921641154825,0.8951078358845175 -"NAM",Namibia,no facility,2533795.1763287843,1234275.7482399999,291224.7577036336,0.4871253050644535,0.23241811849504124,0.7675818815049588 +NAM,Namibia,no facility,2533795.1763287843,1234275.7482399999,291224.7577036336,0.4871253050644535,0.23241811849504124,0.7675818815049588 NER,Niger,no facility,21477381.84057851,14572181.98173,2462828.028383099,0.6784896823037293,0.026499646906286825,0.9735003530937132 NGA,Nigeria,no facility,190886295.59758583,37803730.06439,7712798.176504739,0.19804318558355488,0.22052635008953633,0.7794736499104635 REU,Réunion,no facility,876561.9461389979,0,0,0,NA,NA diff --git a/inst/extdata/fsmglobal.xlsx b/inst/extdata/fsmglobal.xlsx index 1262632..ccb3b43 100644 Binary files a/inst/extdata/fsmglobal.xlsx and b/inst/extdata/fsmglobal.xlsx differ diff --git a/vignettes/articles/examples.Rmd b/vignettes/articles/examples.Rmd index 626bdd7..0e1f1da 100644 --- a/vignettes/articles/examples.Rmd +++ b/vignettes/articles/examples.Rmd @@ -18,6 +18,7 @@ knitr::opts_chunk$set( library(fsmglobal) library(gt) library(dplyr) +library(ggplot2) ``` ```{r} @@ -32,11 +33,6 @@ tbl_emptying_demand_global <- fsmglobal |> ) ``` -```{r} - - -``` - ```{r} tbl_emptying_demand_global |> @@ -52,9 +48,3 @@ tbl_emptying_demand_global |> ``` -```{r} -fsmglobal |> - ggplot(aes(x = percent, y = country, fill = emptying_method)) + - geom_col() -``` -