Skip to content

Commit

Permalink
docsify
Browse files Browse the repository at this point in the history
  • Loading branch information
vincentarelbundock committed Nov 23, 2023
1 parent 203af43 commit ebe542e
Show file tree
Hide file tree
Showing 32 changed files with 1,120 additions and 1,040 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
.Ruserdata
*.DS_Store
README.html
altdoc/freeze.rds
52 changes: 27 additions & 25 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# countrycode 1.5.0.9000
# News

## countrycode 1.5.0.9000

* Important speed-up for detection of country names using regular expressions (Thanks to Etienne Bacher).
* `countryname` gets the `nomatch` argument.
* `countryname` returns NA when the code does not support a given country. (Issue #336)
* Improved regex for Italy

# countrycode 1.5.0
## countrycode 1.5.0

* `get_dictionary()` function to download custom dictionaries (cross-walks):
- US States, Swiss Cantons, Global Burden of Disease, ExioBase, GTAP.
Expand All @@ -14,16 +16,16 @@
* Many regex improvements
* Several minor bug fixes

# countrycode 1.4.0
## countrycode 1.4.0

* Detect French country names using regular expressions: `origin = "country.name.fr"` (Thanks to Samuel Meichtry)
* Detect Italian country names using regular expressions: `origin = "country.name.it"` (Thanks to Samuel Meichtry)

# countrycode 1.3.1
## countrycode 1.3.1

* New code: unhcr

# countrycode 1.3.0
## countrycode 1.3.0

* destination argument accepts a vector of strings and tries one after the other
* countryname(warn=TRUE) by default
Expand All @@ -34,7 +36,7 @@
* Various regex improvements
* Congo French disambiguation

# countrycode 1.2.0
## countrycode 1.2.0

* New 'countryname' function converts country names from any language (thanks to @davidsjoberg)
* New `guess_field` function guesses which code a vector uses
Expand All @@ -46,23 +48,23 @@
* Added IANA ccTLD codes
* Improved various regexes

# countrycode 1.1.3
## countrycode 1.1.3

* Added Demographic and Health Surveys (thanks to @mcooper)

# countrycode 1.1.2
## countrycode 1.1.2

* Updated World Bank regions with manual additions

# countrycode 1.1.1
## countrycode 1.1.1

* Bug: Typo prevented users for using "p4n" as origin code
* Fixed bad icao.region codes (Thanks to @espinielli)
* Added country name "United Arab Republic" and its regex (Thanks to Gina Reynolds)
* Added SOM to wb code (Thanks to Fabian Besche)
* Added Vietnam to codelist_panel

# countrycode 1.1.0
## countrycode 1.1.0

* Gleditsch and Ward codes (Thanks to Altaf Ali)
* V-Dem 8 country codes (panel and cross-section)
Expand All @@ -71,7 +73,7 @@
* Scraping function for UN M49 codes. (Thanks to @cjyetman and @emilBeBri)
* `nomatch = NULL` now works as expected when sourcvar is a factor (#192 thanks to @jhuovari for reporting)

# countrycode 1.0.0
## countrycode 1.0.0

* Huge thanks to @cjyetman for his incredible work on this major release!
* Country-Year (panel) conversion dictionary
Expand All @@ -80,7 +82,7 @@
* Russia eurocontrol region fix
* CLRD country names

# countrycode 0.19.1
## countrycode 0.19.1

* Move to Semantic Versioning 2.0.0
http://semver.org/#semantic-versioning-specification-semver
Expand All @@ -89,7 +91,7 @@
* Removed lookbehind from Ireland regex for javascript compatibility (request by plotly)
* Added nomatch argument

# countrycode 0.19
## countrycode 0.19

New features

Expand Down Expand Up @@ -126,13 +128,13 @@ Misc:
* Better docs, examples, and README
* Taiwan FAO code is 214 (Thanks to Matthieu Stigler)

# countrycode 0.18
## countrycode 0.18

* Nils Enevoldsen did wonderful work refactoring most of the regex in the dictionary.
* Nils also added a bunch of tests. Thanks!
* Added Tokelau

# countrycode 0.17
## countrycode 0.17

* Added International Olympic Committee codes (Thanks to Devon Meunier)
* Bug: fips04 -> fips104 (Thanks to Florian Hollenbach)
Expand All @@ -142,11 +144,11 @@ Misc:
* Regex fix to work better with Database of Political Insitutions (Thanks to Christopher Gandrud)
* Avoids confusion with Eq Guinea (Thanks to Christopher Gandrud)

# countrycode 0.16
## countrycode 0.16

* Bug: NA cowc -> ABW (Thanks to Jon Mellon)

# countrycode 0.15
## countrycode 0.15

* Regex fixes
- Guinea
Expand All @@ -159,41 +161,41 @@ Misc:
- Korea Somalia
- Oman

# countrycode 0.14
## countrycode 0.14

* sint maarten typo

# countrycode 0.13
## countrycode 0.13

* add sint maartin & curacao (thanks johnb30)

# countrycode 0.12
## countrycode 0.12

* Missing wb codes filled-in using iso3c
* Added South Sudan
* Thanks to Rod Alence!

# countrycode 0.11
## countrycode 0.11

* Vietnam cown
* Regexes:
- Dominica / Dominican Republic
- New Zealand / Aland

# countrycode 0.10
## countrycode 0.10

* De-duplicate Sudan
* Niger vs. Nigeria regex

# countrycode 0.9
## countrycode 0.9

* Fixed regexes: Mali, Korea, Oman, Dominica

# countrycode 0.8
## countrycode 0.8

* Added World Bank (wb) country codes. Very similar, but slightly different from iso3c.

# countrycode 0.7
## countrycode 0.7

* Removed useless functions countrycode.nomatch and countryframe
* Fixed 2 Congo-related problems
Expand Down
1 change: 1 addition & 0 deletions R/countrycode-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,6 @@
#' \url{http://arelbundock.com}
#' \url{https://github.com/vincentarelbundock/countrycode}
#' @docType package
#' @noRd
#' @keywords package
NULL
23 changes: 10 additions & 13 deletions README.Rmd
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
---
output: github_document
title: countrycode
---

<img src="https://user-images.githubusercontent.com/987057/167296405-e7798ac8-03e7-444e-acaf-d99fc42d1c9e.png" align="right" alt="" width="120" />
<p align="center">
<img src="https://user-images.githubusercontent.com/987057/167296405-e7798ac8-03e7-444e-acaf-d99fc42d1c9e.png" align="right" alt="" width="125" />
</p>
<br>

<!-- badges: start -->
[![DOI](http://joss.theoj.org/papers/10.21105/joss.00848/status.svg)](https://doi.org/10.21105/joss.00848)
[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/vincentarelbundock/countrycode?branch=master&svg=true)](https://ci.appveyor.com/project/vincentarelbundock/countrycode)
[![R build status](https://github.com/vincentarelbundock/countrycode/workflows/R-CMD-check/badge.svg)](https://github.com/vincentarelbundock/countrycode/actions)
![CRAN downloads](http://cranlogs.r-pkg.org/badges/grand-total/countrycode)
[![Downloads](https://cranlogs.r-pkg.org/badges/ggplot2)](https://cran.rstudio.com/web/packages/countrycode/index.html)
<!-- badges: end -->

`countrycode` standardizes country names, converts them into ~40 different coding schemes, and assigns region descriptors. Scroll down for more details or visit the [countrycode CRAN page](http://cran.r-project.org/web/packages/countrycode/index.html)
Expand All @@ -18,17 +15,17 @@ If you use `countrycode` in your research, we would be very grateful if you coul

> Arel-Bundock, Vincent, Nils Enevoldsen, and CJ Yetman, (2018). countrycode: An R package to convert country names and country codes. Journal of Open Source Software, 3(28), 848, https://doi.org/10.21105/joss.00848
# Why `countrycode`?
## Why `countrycode`?

## The Problem
### The Problem

Different data sources use different coding schemes to represent countries (e.g. CoW or ISO). This poses two main problems: (1) some of these coding schemes are less than intuitive, and (2) merging these data requires converting from one coding scheme to another, or from long country names to a coding scheme.

## The Solution
### The Solution

The `countrycode` function can convert to and from 40+ different country coding schemes, and to 600+ variants of country names in different languages and formats. It uses regular expressions to convert long country names (e.g. Sri Lanka) into any of those coding schemes or country names. It can create new variables with various regional groupings.

# Installation
## Installation

From the R console, type:

Expand All @@ -43,7 +40,7 @@ library(remotes)
install_github('vincentarelbundock/countrycode')
```

# Supported codes
## Supported codes

To get an up-to-date list of supported country codes, install the package and type `?codelist`. These include:

Expand Down
73 changes: 36 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
countrycode
================

<img src="https://user-images.githubusercontent.com/987057/167296405-e7798ac8-03e7-444e-acaf-d99fc42d1c9e.png" align="right" alt="" width="120" />
<p align="center">
<img src="https://user-images.githubusercontent.com/987057/167296405-e7798ac8-03e7-444e-acaf-d99fc42d1c9e.png" align="right" alt="" width="125" />
</p>

<br>

<!-- badges: start -->

[![DOI](http://joss.theoj.org/papers/10.21105/joss.00848/status.svg)](https://doi.org/10.21105/joss.00848)
[![AppVeyor build
status](https://ci.appveyor.com/api/projects/status/github/vincentarelbundock/countrycode?branch=master&svg=true)](https://ci.appveyor.com/project/vincentarelbundock/countrycode)
[![R build
status](https://github.com/vincentarelbundock/countrycode/workflows/R-CMD-check/badge.svg)](https://github.com/vincentarelbundock/countrycode/actions)
![CRAN
downloads](http://cranlogs.r-pkg.org/badges/grand-total/countrycode)
[![Downloads](https://cranlogs.r-pkg.org/badges/ggplot2.png)](https://cran.rstudio.com/web/packages/countrycode/index.html)
<!-- badges: end -->

`countrycode` standardizes country names, converts them into ~40
Expand All @@ -25,19 +24,19 @@ you could cite our paper:
> Arel-Bundock, Vincent, Nils Enevoldsen, and CJ Yetman, (2018).
> countrycode: An R package to convert country names and country codes.
> Journal of Open Source Software, 3(28), 848,
> <https://doi.org/10.21105/joss.00848>
> https://doi.org/10.21105/joss.00848
# Why `countrycode`?
## Why `countrycode`?

## The Problem
### The Problem

Different data sources use different coding schemes to represent
countries (e.g. CoW or ISO). This poses two main problems: (1) some of
these coding schemes are less than intuitive, and (2) merging these data
requires converting from one coding scheme to another, or from long
country names to a coding scheme.

## The Solution
### The Solution

The `countrycode` function can convert to and from 40+ different country
coding schemes, and to 600+ variants of country names in different
Expand All @@ -46,7 +45,7 @@ country names (e.g. Sri Lanka) into any of those coding schemes or
country names. It can create new variables with various regional
groupings.

# Installation
## Installation

From the R console, type:

Expand All @@ -62,32 +61,32 @@ library(remotes)
install_github('vincentarelbundock/countrycode')
```

# Supported codes
## Supported codes

To get an up-to-date list of supported country codes, install the
package and type `?codelist`. These include:

- 600+ variants of country names in different languages and formats.
- AR5
- Continent and region identifiers.
- Correlates of War (numeric and character)
- European Central Bank
- [EUROCONTROL](https://www.eurocontrol.int) - The European Organisation
for the Safety of Air Navigation
- Eurostat
- Federal Information Processing Standard (FIPS)
- Food and Agriculture Organization of the United Nations
- Global Administrative Unit Layers (GAUL)
- Geopolitical Entities, Names and Codes (GENC)
- Gleditsch & Ward (numeric and character)
- International Civil Aviation Organization
- International Monetary Fund
- International Olympic Committee
- ISO (2/3-character and numeric)
- Polity IV
- United Nations
- United Nations Procurement Division
- Varieties of Democracy
- World Bank
- World Values Survey
- Unicode symbols (flags)
- 600+ variants of country names in different languages and formats.
- AR5
- Continent and region identifiers.
- Correlates of War (numeric and character)
- European Central Bank
- [EUROCONTROL](https://www.eurocontrol.int) - The European
Organisation for the Safety of Air Navigation
- Eurostat
- Federal Information Processing Standard (FIPS)
- Food and Agriculture Organization of the United Nations
- Global Administrative Unit Layers (GAUL)
- Geopolitical Entities, Names and Codes (GENC)
- Gleditsch & Ward (numeric and character)
- International Civil Aviation Organization
- International Monetary Fund
- International Olympic Committee
- ISO (2/3-character and numeric)
- Polity IV
- United Nations
- United Nations Procurement Division
- Varieties of Democracy
- World Bank
- World Values Survey
- Unicode symbols (flags)
Empty file added altdoc/.nojekyll
Empty file.
Loading

0 comments on commit ebe542e

Please sign in to comment.