diff --git a/.gitignore b/.gitignore index a3a7275..f4895f3 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ .Ruserdata *.DS_Store README.html +altdoc/freeze.rds diff --git a/NEWS.md b/NEWS.md index 0b99111..540795a 100644 --- a/NEWS.md +++ b/NEWS.md @@ -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. @@ -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 @@ -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 @@ -46,15 +48,15 @@ * 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) @@ -62,7 +64,7 @@ * 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) @@ -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 @@ -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 @@ -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 @@ -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) @@ -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 @@ -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 diff --git a/R/countrycode-package.R b/R/countrycode-package.R index 48b3bad..c4d91b8 100644 --- a/R/countrycode-package.R +++ b/R/countrycode-package.R @@ -18,5 +18,6 @@ #' \url{http://arelbundock.com} #' \url{https://github.com/vincentarelbundock/countrycode} #' @docType package +#' @noRd #' @keywords package NULL diff --git a/README.Rmd b/README.Rmd index f5e44e2..12d3e95 100644 --- a/README.Rmd +++ b/README.Rmd @@ -1,15 +1,12 @@ ---- -output: github_document -title: countrycode ---- - - +

+ +

+
[![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) `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) @@ -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: @@ -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: diff --git a/README.md b/README.md index cac08c0..ac6d2d9 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,16 @@ -countrycode -================ - +

+ +

+ +
[![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) `countrycode` standardizes country names, converts them into ~40 @@ -25,11 +24,11 @@ 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 -# 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 @@ -37,7 +36,7 @@ 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 @@ -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: @@ -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) diff --git a/altdoc/.nojekyll b/altdoc/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/altdoc/docsify.html b/altdoc/docsify.html new file mode 100644 index 0000000..1d99413 --- /dev/null +++ b/altdoc/docsify.html @@ -0,0 +1,45 @@ + + + + + + + + + + + +
+ + + + + + + diff --git a/altdoc/docsify.md b/altdoc/docsify.md new file mode 100644 index 0000000..eee1362 --- /dev/null +++ b/altdoc/docsify.md @@ -0,0 +1,18 @@ +* [Home](/) +* Vignettes: + - [Country codes](vignettes/countrycode.md) + - [Country names](vignettes/countryname.md) + - [Custom conversion functions](vignettes/custom.md) + - [Contributions](vignettes/contributions.md) +* Functions and dictionaries: + - [countrycode](man/countrycode) + - [countryname](man/countryname) + - [get_dictionary](man/get_dictionary) + - [guess_field](man/guess_field) + - [cldr_examples](man/cldr_examples) + - [codelist_panel](man/codelist_panel) + - [codelist](man/codelist) + - [countryname_dict](man/countryname_dict) +* [News](NEWS.md) +* [License](LICENSE.md) +* [Citation](CITATION.md) diff --git a/altdoc/docute.html b/altdoc/docute.html deleted file mode 100644 index ad52a34..0000000 --- a/altdoc/docute.html +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - $ALTDOC_PACKAGE_NAME - - - - - -
- - - - diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/docs/CITATION.md b/docs/CITATION.md new file mode 100644 index 0000000..286a73f --- /dev/null +++ b/docs/CITATION.md @@ -0,0 +1,23 @@ +# Citation + +```verbatim +To cite countrycode in publications use: + + Arel-Bundock V, Enevoldsen N, Yetman C (2018). “countrycode: An R + package to convert country names and country codes.” _Journal of Open + Source Software_, *3*(28), 848. + . + +A BibTeX entry for LaTeX users is + + @Article{, + title = {countrycode: An R package to convert country names and country codes}, + author = {Vincent Arel-Bundock and Nils Enevoldsen and CJ Yetman}, + journal = {Journal of Open Source Software}, + year = {2018}, + volume = {3}, + number = {28}, + pages = {848}, + url = {https://doi.org/10.21105/joss.00848}, + } +``` diff --git a/docs/LICENSE.md b/docs/LICENSE.md new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/docs/LICENSE.md @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/docs/NEWS.md b/docs/NEWS.md index cf28cea..20c190c 100644 --- a/docs/NEWS.md +++ b/docs/NEWS.md @@ -1,154 +1,156 @@ -# countrycode 1.5.0.9000 +# News -- 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](https://github.com/vincentarelbundock/countrycode/issues/336)) -- Improved regex for Italy +## 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](https://github.com/vincentarelbundock/countrycode/issues/336)) +* Improved regex for Italy ## countrycode 1.5.0 -- `get_dictionary()` function to download custom dictionaries (cross-walks): - - US States, Swiss Cantons, Global Burden of Disease, ExioBase, GTAP. -- New codes: Polity V "p5c", "p5n" -- New code "unhcr\_region". Thanks to [@galalH](https://github.com/galalH) for code contribution [#329](https://github.com/vincentarelbundock/countrycode/issues/329) -- Many regex improvements -- Several minor bug fixes +* `get_dictionary()` function to download custom dictionaries (cross-walks): + - US States, Swiss Cantons, Global Burden of Disease, ExioBase, GTAP. +* New codes: Polity V "p5c", "p5n" +* New code "unhcr_region". Thanks to [@galalH](https://github.com/galalH) for code contribution [#329](https://github.com/vincentarelbundock/countrycode/issues/329) +* Many regex improvements +* Several minor bug fixes ## 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) +* 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 -- New code: unhcr +* New code: unhcr ## countrycode 1.3.0 -- destination argument accepts a vector of strings and tries one after the other -- countryname(warn=TRUE) by default -- better class checks -- countryname defaults to `country.name.en` for missing country names (nomatch=NULL) -- Vietnam: better regex and support for vdem -- Namibia fixes: eurostat, genc2c, wb\_api2c, ecb -- Various regex improvements -- Congo French disambiguation +* destination argument accepts a vector of strings and tries one after the other +* countryname(warn=TRUE) by default +* better class checks +* countryname defaults to `country.name.en` for missing country names (nomatch=NULL) +* Vietnam: better regex and support for vdem +* Namibia fixes: eurostat, genc2c, wb_api2c, ecb +* Various regex improvements +* Congo French disambiguation ## countrycode 1.2.0 -- New 'countryname' function converts country names from any language (thanks to [@davidsjoberg](https://github.com/davidsjoberg)) -- New `guess_field` function guesses which code a vector uses -- Bug in dict build inserted NA in region variable (Thanks to M. Pascariu) -- Added region23 with the old, more granular regions -- Added unicode.symbol, which converts to emoji flags -- Added ISO 4217 currency name, alpha, and numeric codes -- Added UN region codes and names -- Added IANA ccTLD codes -- Improved various regexes +* New 'countryname' function converts country names from any language (thanks to [@davidsjoberg](https://github.com/davidsjoberg)) +* New `guess_field` function guesses which code a vector uses +* Bug in dict build inserted NA in region variable (Thanks to M. Pascariu) +* Added region23 with the old, more granular regions +* Added unicode.symbol, which converts to emoji flags +* Added ISO 4217 currency name, alpha, and numeric codes +* Added UN region codes and names +* Added IANA ccTLD codes +* Improved various regexes -## countrycode 1.1.3 +## countrycode 1.1.3 -- Added Demographic and Health Surveys (thanks to [@mcooper](https://github.com/mcooper)) +* Added Demographic and Health Surveys (thanks to [@mcooper](https://github.com/mcooper)) -## countrycode 1.1.2 +## countrycode 1.1.2 -- Updated World Bank regions with manual additions +* 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](https://github.com/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 +* Bug: Typo prevented users for using "p4n" as origin code +* Fixed bad icao.region codes (Thanks to [@espinielli](https://github.com/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) -- Fixed Netherlands Antilles test (ANT code retired by ISO) -- codelist\_panel now excludes years where a country didn't exist -- Scraping function for UN M49 codes. (Thanks to [@cjyetman](https://github.com/cjyetman) and [@emilBeBri](https://github.com/emilBeBri)) -- `nomatch = NULL` now works as expected when sourcvar is a factor ([#192](https://github.com/vincentarelbundock/countrycode/issues/192) thanks to [@jhuovari](https://github.com/jhuovari) for reporting) +* Gleditsch and Ward codes (Thanks to Altaf Ali) +* V-Dem 8 country codes (panel and cross-section) +* Fixed Netherlands Antilles test (ANT code retired by ISO) +* codelist_panel now excludes years where a country didn't exist +* Scraping function for UN M49 codes. (Thanks to [@cjyetman](https://github.com/cjyetman) and [@emilBeBri](https://github.com/emilBeBri)) +* `nomatch = NULL` now works as expected when sourcvar is a factor ([#192](https://github.com/vincentarelbundock/countrycode/issues/192) thanks to [@jhuovari](https://github.com/jhuovari) for reporting) -## countrycode 1.0.0 +## countrycode 1.0.0 -- Huge thanks to [@cjyetman](https://github.com/cjyetman) for his incredible work on this major release! -- Country-Year (panel) conversion dictionary -- Dictionary built from original sources -- Liechtenstein should not be in eu28 -- Russia eurocontrol region fix -- CLRD country names +* Huge thanks to [@cjyetman](https://github.com/cjyetman) for his incredible work on this major release! +* Country-Year (panel) conversion dictionary +* Dictionary built from original sources +* Liechtenstein should not be in eu28 +* 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](http://semver.org/#semantic-versioning-specification-semver) -- Fixed North Korea regex and added tests -- Fixed Sudan iso3n code -- Removed lookbehind from Ireland regex for javascript compatibility (request by plotly) -- Added nomatch argument +* Move to Semantic Versioning 2.0.0 + http://semver.org/#semantic-versioning-specification-semver +* Fixed North Korea regex and added tests +* Fixed Sudan iso3n code +* Removed lookbehind from Ireland regex for javascript compatibility (request by plotly) +* Added nomatch argument -## countrycode 0.19 +## countrycode 0.19 New features -- "custom\_dict" argument allows user-supplied dictionary data.frames -- "custom\_match" argument allows a user-supplied named vector of custom +* "custom_dict" argument allows user-supplied dictionary data.frames +* "custom_match" argument allows a user-supplied named vector of custom origin->destination matches that will supercede any matching values in the default result (issue [#107](https://github.com/vincentarelbundock/countrycode/issues/107)) (Thanks to [@cjyetman](https://github.com/cjyetman)) -- German, French, Spanish, Russian, Chinese, and Arabic country names as destination codes -- German regular expression to convert from German names to codes. (Thanks to [@sumtxt](https://github.com/sumtxt)) -- Aviation codes (Thanks to Enrico Spinielli) -- ar5 and eu28 (Thanks to Niklas Roming) -- eurostat (Thanks to [@cjyetman](https://github.com/cjyetman)) -- 2 and 3 character codes for the World Bank API: wb\_api2c and wb\_api3c (Thanks to [@cjyetman](https://github.com/cjyetman)) -- alpha and numeric codes for Polity IV: p4\_scode and p4\_ccode (Thanks to [@cjyetman](https://github.com/cjyetman)) -- World Values Survey numeric code (Thanks to [@cjyetman](https://github.com/cjyetman)) +* German, French, Spanish, Russian, Chinese, and Arabic country names as destination codes +* German regular expression to convert from German names to codes. (Thanks to [@sumtxt](https://github.com/sumtxt)) +* Aviation codes (Thanks to Enrico Spinielli) +* ar5 and eu28 (Thanks to Niklas Roming) +* eurostat (Thanks to [@cjyetman](https://github.com/cjyetman)) +* 2 and 3 character codes for the World Bank API: wb_api2c and wb_api3c (Thanks to [@cjyetman](https://github.com/cjyetman)) +* alpha and numeric codes for Polity IV: p4_scode and p4_ccode (Thanks to [@cjyetman](https://github.com/cjyetman)) +* World Values Survey numeric code (Thanks to [@cjyetman](https://github.com/cjyetman)) Regex fixes and improvements: -- Improved regex for Ireland and United States of America (Thanks to [@cjyetman](https://github.com/cjyetman)) -- D.R. Congo (found in WVS) matches Democratic Republic of the Congo (Thanks to [@cjyetman](https://github.com/cjyetman)) -- Southern Africa -- Federated States of Micronesia -- Republic of China == Taiwan (Thanks to Nils Enevoldsen) -- Martinique (Thanks to Martyn Plummer) -- Tahiti country name string converts to French Polynesia +* Improved regex for Ireland and United States of America (Thanks to [@cjyetman](https://github.com/cjyetman)) +* D.R. Congo (found in WVS) matches Democratic Republic of the Congo (Thanks to [@cjyetman](https://github.com/cjyetman)) +* Southern Africa +* Federated States of Micronesia +* Republic of China == Taiwan (Thanks to Nils Enevoldsen) +* Martinique (Thanks to Martyn Plummer) +* Tahiti country name string converts to French Polynesia Misc: -- Major speed-up in regex conversion by using factors (Thanks to [@cjyetman](https://github.com/cjyetman)) -- when more than one match is found for a given string, is returned rather +* Major speed-up in regex conversion by using factors (Thanks to [@cjyetman](https://github.com/cjyetman)) +* when more than one match is found for a given string, is returned rather than arbitrarily choosing the last match found (Thanks to [@cjyetman](https://github.com/cjyetman)) -- updated tests to new testthat convention (Thanks to [@cjyetman](https://github.com/cjyetman)) -- English country names are now official UN versions -- Better docs, examples, and README -- Taiwan FAO code is 214 (Thanks to Matthieu Stigler) +* updated tests to new testthat convention (Thanks to [@cjyetman](https://github.com/cjyetman)) +* English country names are now official UN versions +* 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 +* 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) -- Complete FIPS104 codes (Thanks to Andy Halterman) -- Generic code name validity check (Thanks to Stefan Zeugner) -- Fixed IMF codes (Thanks to Stefan Zeugner) -- Regex fix to work better with Database of Political Insitutions (Thanks to Christopher Gandrud) -- Avoids confusion with Eq Guinea (Thanks to Christopher Gandrud) +* Added International Olympic Committee codes (Thanks to Devon Meunier) +* Bug: fips04 -> fips104 (Thanks to Florian Hollenbach) +* Complete FIPS104 codes (Thanks to Andy Halterman) +* Generic code name validity check (Thanks to Stefan Zeugner) +* Fixed IMF codes (Thanks to Stefan Zeugner) +* 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) +* Bug: NA cowc -> ABW (Thanks to Jon Mellon) -## countrycode 0.15 +## countrycode 0.15 -- Regex fixes +* Regex fixes - Guinea - West Bank - Kitts / Christopher @@ -159,45 +161,47 @@ Misc: - Korea Somalia - Oman -## countrycode 0.14 +## countrycode 0.14 -- sint maarten typo +* sint maarten typo -## countrycode 0.13 +## countrycode 0.13 -- add sint maartin \& curacao (thanks johnb30) +* 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! +* Missing wb codes filled-in using iso3c +* Added South Sudan +* Thanks to Rod Alence! -## countrycode 0.11 +## countrycode 0.11 -- Vietnam cown -- Regexes: +* Vietnam cown +* Regexes: - Dominica / Dominican Republic - New Zealand / Aland -## countrycode 0.10 +## countrycode 0.10 -- De-duplicate Sudan -- Niger vs. Nigeria regex +* De-duplicate Sudan +* Niger vs. Nigeria regex -## countrycode 0.9 +## countrycode 0.9 -- Fixed regexes: Mali, Korea, Oman, Dominica +* 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. +* Added World Bank (wb) country codes. Very similar, but slightly different from iso3c. ## countrycode 0.7 -- Removed useless functions countrycode.nomatch and countryframe -- Fixed 2 Congo-related problems -- Added option for countrycode() to report codes for which no match was found -- Moved documentation to roxygen2 -- Fixed Trinidad Tobago regex -- Added UN and FAO country codes +* Removed useless functions countrycode.nomatch and countryframe +* Fixed 2 Congo-related problems +* Added option for countrycode() to report codes for which no match was found +* Moved documentation to roxygen2 +* Fixed Trinidad Tobago regex +* Added UN and FAO country codes + + diff --git a/docs/README.md b/docs/README.md index 22ced53..ac6d2d9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,17 +1,16 @@ -# countrycode - +

+ +

+ +
[![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) `countrycode` standardizes country names, converts them into ~40 @@ -25,7 +24,7 @@ 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) +> https://doi.org/10.21105/joss.00848 ## Why `countrycode`? @@ -50,14 +49,14 @@ groupings. From the R console, type: -```r +``` r install.packages("countrycode") ``` To install the latest development version, you can use the `remotes` package: -```r +``` r library(remotes) install_github('vincentarelbundock/countrycode') ``` @@ -67,28 +66,27 @@ install_github('vincentarelbundock/countrycode') 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) diff --git a/docs/_sidebar.md b/docs/_sidebar.md new file mode 100644 index 0000000..eee1362 --- /dev/null +++ b/docs/_sidebar.md @@ -0,0 +1,18 @@ +* [Home](/) +* Vignettes: + - [Country codes](vignettes/countrycode.md) + - [Country names](vignettes/countryname.md) + - [Custom conversion functions](vignettes/custom.md) + - [Contributions](vignettes/contributions.md) +* Functions and dictionaries: + - [countrycode](man/countrycode) + - [countryname](man/countryname) + - [get_dictionary](man/get_dictionary) + - [guess_field](man/guess_field) + - [cldr_examples](man/cldr_examples) + - [codelist_panel](man/codelist_panel) + - [codelist](man/codelist) + - [countryname_dict](man/countryname_dict) +* [News](NEWS.md) +* [License](LICENSE.md) +* [Citation](CITATION.md) diff --git a/docs/docsify.html b/docs/docsify.html new file mode 100644 index 0000000..1d99413 --- /dev/null +++ b/docs/docsify.html @@ -0,0 +1,45 @@ + + + + + + + + + + + +
+ + + + + + + diff --git a/docs/index.html b/docs/index.html index edab1b3..62b1899 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,69 +1,45 @@ + + - - - - countrycode - - - - - -
- - - + + + + + + + +
+ + + + + + diff --git a/docs/man/countrycode-package.md b/docs/man/countrycode-package.md deleted file mode 100644 index f5cb83f..0000000 --- a/docs/man/countrycode-package.md +++ /dev/null @@ -1,30 +0,0 @@ - -# countrycode-package - -Convert Country Codes or Country Names - -## Description - -Convert country codes or country names - -## Details - -The countrycode function can convert to and from several -different country coding schemes. It uses regular expressions to convert -country names (e.g. Sri Lanka) into any of those coding schemes, or into -standardized country names in several languages. It can create variables -with the name of the continent and/or several regional groupings to -which each country belongs. - -Type ?codelist to get a list of available origin and destination codes. - -## Author(s) - -Vincent Arel-Bundock -vincent.arel-bundock@umontreal.ca - -## References - -
\url{http://arelbundock.com}
-\url{https://github.com/vincentarelbundock/countrycode}
-
diff --git a/docs/man/countrycode.md b/docs/man/countrycode.md index 9d9aecc..7865d6f 100644 --- a/docs/man/countrycode.md +++ b/docs/man/countrycode.md @@ -164,58 +164,24 @@ library(countrycode) # ISO to Correlates of War countrycode(c('USA', 'DZA'), origin = 'iso3c', destination = 'cown') -``` - - [1] 2 615 -``` r # English to ISO countrycode('Albania', origin = 'country.name', destination = 'iso3c') -``` - [1] "ALB" - -``` r # German to French countrycode('Albanien', origin = 'country.name.de', destination = 'iso.name.fr') -``` - - [1] "Albanie (l')" -``` r # Using custom_match to supercede default codes countrycode(c('United States', 'Algeria'), 'country.name', 'iso3c') -``` - - [1] "USA" "DZA" - -``` r countrycode(c('United States', 'Algeria'), 'country.name', 'iso3c', custom_match = c('Algeria' = 'ALG')) -``` - [1] "USA" "ALG" - -``` r x <- c("canada", "antarctica") countryname(x) -``` - - [1] "Canada" "Antarctica" - -``` r countryname(x, destination = "cowc", warn = FALSE) -``` - - [1] "CAN" NA - -``` r countryname(x, destination = "cowc", warn = FALSE, nomatch = x) -``` - - [1] "CAN" "antarctica" -``` r + library(countrycode) # Download the dictionary of US states from Github state_dict <- "https://raw.githubusercontent.com/vincentarelbundock/countrycode/main/data/custom_dictionaries/data_us_states.csv" @@ -225,13 +191,6 @@ countryname(x, destination = "cowc", warn = FALSE, nomatch = x) attr(state_dict, "origin_regex") <- "state.regex" countrycode(c('AL', 'AK'), 'abbreviation', 'state', custom_dict = state_dict) -``` - - [1] "Alabama" "Alaska" - -``` r countrycode(c('Alabama', 'North Dakota'), 'state.regex', 'state', custom_dict = state_dict) ``` - - [1] "Alabama" "North Dakota" diff --git a/docs/man/countryname.md b/docs/man/countryname.md index 28cdccc..0acdf8c 100644 --- a/docs/man/countryname.md +++ b/docs/man/countryname.md @@ -79,12 +79,5 @@ library(countrycode) x <- c('Afaganisitani', 'Barbadas', 'Sverige', 'UK') countryname(x) -``` - - [1] "Afghanistan" "Barbados" "Sweden" "United Kingdom" - -``` r countryname(x, destination = 'iso3c') ``` - - [1] "AFG" "BRB" "SWE" "GBR" diff --git a/docs/man/get_dictionary.md b/docs/man/get_dictionary.md index 368b426..ed1e8fd 100644 --- a/docs/man/get_dictionary.md +++ b/docs/man/get_dictionary.md @@ -43,5 +43,3 @@ library(countrycode) cd <- get_dictionary("us_states") countrycode::countrycode(c("MO", "MN"), origin = "state.abb", "state.name", custom_dict = cd) ``` - - [1] "Missouri" "Minnesota" diff --git a/docs/reference.md b/docs/reference.md deleted file mode 100644 index cf78241..0000000 --- a/docs/reference.md +++ /dev/null @@ -1,564 +0,0 @@ -# Reference - -## Cldr examples - -### Description - -- Code: CLDR code - -- Example: French Southern Territories in different languages - -### Usage - - cldr_examples - -### Format - -data frame - - ---- -## Codelist panel - -### Description - -A panel of country-year observations with various codes - -### Usage - - codelist_panel - -### Format - -data frame with codes as columns - - ---- -## Codelist - -### Description - -A data frame used internally by the `countrycode()` function. -`countrycode` can use any valid code as destination, but only some codes -can be used as origin. - -### Format - -A data frame with codes as columns. - -### Details - -#### Origin and Destination - -- `cctld`: IANA country code top-level domain - -- `country.name`: country name (English) - -- `country.name.de`: country name (German) - -- `country.name.fr`: country name (French) - -- `country.name.it`: country name (Italian) - -- `cowc`: Correlates of War character - -- `cown`: Correlates of War numeric - -- `dhs`: Demographic and Health Surveys Program - -- `ecb`: European Central Bank - -- `eurostat`: Eurostat - -- `fao`: Food and Agriculture Organization of the United Nations - numerical code - -- `fips`: FIPS 10-4 (Federal Information Processing Standard) - -- `gaul`: Global Administrative Unit Layers - -- `genc2c`: GENC 2-letter code - -- `genc3c`: GENC 3-letter code - -- `genc3n`: GENC numeric code - -- `gwc`: Gleditsch & Ward character - -- `gwn`: Gleditsch & Ward numeric - -- `imf`: International Monetary Fund - -- `ioc`: International Olympic Committee - -- `iso2c`: ISO-2 character - -- `iso3c`: ISO-3 character - -- `iso3n`: ISO-3 numeric - -- `p5n`: Polity V numeric country code - -- `p5c`: Polity V character country code - -- `p4n`: Polity IV numeric country code - -- `p4c`: Polity IV character country code - -- `un`: United Nations M49 numeric codes - -- `unicode.symbol`: Region subtag (often displayed as emoji flag) - -- `unhcr`: United Nations High Commissioner for Refugees - -- `unpd`: United Nations Procurement Division - -- `vdem`: Varieties of Democracy (V-Dem version 8, April 2018) - -- `wb`: World Bank (very similar but not identical to iso3c) - -- `wvs`: World Values Survey numeric code - -#### Destination only - -- `⁠cldr.*⁠`: 600+ country name variants from the UNICODE CLDR project - (e.g., "cldr.short.en"). Inspect the `cldr_examples` data.frame for - a full list of available country names and examples. - -- `ar5`: IPCC's regional mapping used both in the Fifth Assessment - Report (AR5) and for the Reference Concentration Pathways (RCP) - -- `continent`: Continent as defined in the World Bank Development - Indicators - -- `cow.name`: Correlates of War country name - -- `currency`: ISO 4217 currency name - -- `eurocontrol_pru`: European Organisation for the Safety of Air - Navigation - -- `eurocontrol_statfor`: European Organisation for the Safety of Air - Navigation - -- `eu28`: Member states of the European Union (as of December 2015), - without special territories - -- `icao.region`: International Civil Aviation Organization region - -- `iso.name.en`: ISO English short name - -- `iso.name.fr`: ISO French short name - -- `iso4217c`: ISO 4217 currency alphabetic code - -- `iso4217n`: ISO 4217 currency numeric code - -- `p4.name`: Polity IV country name - -- `region`: 7 Regions as defined in the World Bank Development - Indicators - -- `region23`: 23 Regions as used to be in the World Bank Development - Indicators (legacy) - -- `un.name.ar`: United Nations Arabic country name - -- `un.name.en`: United Nations English country name - -- `un.name.es`: United Nations Spanish country name - -- `un.name.fr`: United Nations French country name - -- `un.name.ru`: United Nations Russian country name - -- `un.name.zh`: United Nations Chinese country name - -- `un.region.name`: United Nations region name - -- `un.region.code`: United Nations region code - -- `un.regionintermediate.name`: United Nations intermediate region - name - -- `un.regionintermediate.code`: United Nations intermediate region - code - -- `un.regionsub.name`: United Nations sub-region name - -- `un.regionsub.code`: United Nations sub-region code - -- `unhcr.region`: United Nations High Commissioner for Refugees region - name - -- `wvs.name`: World Values Survey numeric code country name - -### Note - -The Correlates of War (cow) and Polity 4 (p4) project produce codes in -country year format. Some countries go through political transitions -that justify changing codes over time. When building a purely -cross-sectional conversion dictionary, this forces us to make arbitrary -choices with respect to some entities (e.g., Western Germany, Vietnam, -Serbia). `countrycode` includes a reconciled dataset in panel format, -`codelist_panel`. Instead of converting code, we recommend that users -dealing with panel data "left-merge" their data into this panel -dictionary. - - ---- -## Countrycode-package - -### Description - -Convert country codes or country names - -### Details - -The `countrycode` function can convert to and from several different -country coding schemes. It uses regular expressions to convert country -names (e.g. Sri Lanka) into any of those coding schemes, or into -standardized country names in several languages. It can create variables -with the name of the continent and/or several regional groupings to -which each country belongs. - -Type ?codelist to get a list of available origin and destination codes. - -### Author(s) - -Vincent Arel-Bundock - -### References - - \url{http://arelbundock.com} - \url{https://github.com/vincentarelbundock/countrycode} - - ---- -## Countrycode - -### Description - -Converts long country names into one of many different coding schemes. -Translates from one scheme to another. Converts country name or coding -scheme to the official short English country name. Creates a new -variable with the name of the continent or region to which each country -belongs. - -### Usage - - countrycode( - sourcevar, - origin, - destination, - warn = TRUE, - nomatch = NA, - custom_dict = NULL, - custom_match = NULL, - origin_regex = NULL - ) - -### Arguments - - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
sourcevar

Vector which contains the codes or country names to be converted -(character or factor)

origin

A string which identifies the coding scheme of origin (e.g., -"iso3c"). See codelist for a list of available -codes.

destination

A string or vector of strings which identify the coding scheme of -destination (e.g., "iso3c" or -c("cowc", "iso3c")). See codelist for a list -of available codes. When users supply a vector of destination codes, -they are used sequentially to fill in missing values not covered by the -previous destination code in the vector.

warn

Prints unique elements from sourcevar for which no match was -found

nomatch

When countrycode fails to find a match for the code of origin, it -fills-in the destination vector with nomatch. The default -behavior is to fill non-matching codes with NA. If -nomatch = NULL, countrycode tries to use the origin vector -to fill-in missing values in the destination vector. -nomatch must be either NULL, of length 1, or -of the same length as sourcevar.

custom_dict

A data frame which supplies a new dictionary to replace the -built-in country code dictionary. Each column contains a different code -and must include no duplicates. The data frame format should resemble -codelist. Users can pre-assign attributes to this custom -dictionary to affect behavior (see Examples section):

-
    -

  • "origin.regex" attribute: a character vector with the names of -columns containing regular expressions.

    • -

  • "origin.valid" attribute: a character vector with the names of -columns that are accepted as valid origin codes.

    • -
custom_match

A named vector which supplies custom origin and destination -matches that will supercede any matching default result. The name of -each element will be used as the origin code, and the value of each -element will be used as the destination code.

origin_regex

NULL or Logical: When using a custom dictionary, if TRUE then the -origin codes will be matched as regex, if FALSE they will be matched -exactly. When NULL, countrycode will behave as TRUE if the -origin name is in the custom_dictionary's -origin_regex attribute, and FALSE otherwise. See examples -section below.

- -### Note - -For a complete description of available country codes and languages, -please see the documentation for the `codelist` conversion dictionary. - -Panel data (i.e., country-year) can pose particular problems when -converting codes. For instance, some countries like Vietnam or Serbia go -through political transitions that justify changing codes over time. -This can pose problems when using codes from organizations like CoW or -Polity IV, which produce codes in country-year format. Instead of -converting codes using `countrycode()`, we recommend that users use the -`codelist_panel` data.frame as a base into which they can merge their -other data. This data.frame includes most relevant code, and is already -"reconciled" to ensure that each political unit is only represented by -one row in any given year. From there, it is just a matter of using -`merge()` to combine different datasets which use different codes. - -### Examples - -```r -library(countrycode) - -# ISO to Correlates of War -countrycode(c('USA', 'DZA'), origin = 'iso3c', destination = 'cown') - -# English to ISO -countrycode('Albania', origin = 'country.name', destination = 'iso3c') - -# German to French -countrycode('Albanien', origin = 'country.name.de', destination = 'iso.name.fr') - -# Using custom_match to supercede default codes -countrycode(c('United States', 'Algeria'), 'country.name', 'iso3c') -countrycode(c('United States', 'Algeria'), 'country.name', 'iso3c', -custom_match = c('Algeria' = 'ALG')) - -x <- c("canada", "antarctica") -countryname(x) -countryname(x, destination = "cowc", warn = FALSE) -countryname(x, destination = "cowc", warn = FALSE, nomatch = x) - -## Not run: - # Download the dictionary of US states from Github - - state_dict <- "https://raw.githubusercontent.com/vincentarelbundock/countrycode/main/data/custom_dictionaries/data_us_states.csv" - state_dict <- read.csv(state_dict) - - # The "state.regex" column includes regular expressions, so we set an attribute. - attr(state_dict, "origin_regex") <- "state.regex" - countrycode(c('AL', 'AK'), 'abbreviation', 'state', - custom_dict = state_dict) - countrycode(c('Alabama', 'North Dakota'), 'state.regex', 'state', - custom_dict = state_dict) - -## End(Not run) -``` - - ---- -## Countryname dict - -### Description - -A dataframe of alternative country names in many languages. Used -internally by the `countryname` function. - -### Format - -dataframe - - ---- -## Countryname - -### Description - -Converts long country names in any language to one of many different -country code schemes or country names. `countryname` does 2 passes on -the data. First, it tries to detect variations of country names in many -languages extracted from the Unicode Common Locale Data Repository. -Second, it applies `countrycode`'s English regexes to try to match the -remaining cases. Because it does two passes, `countryname` can sometimes -produce ambiguous results, e.g., Saint Martin vs. Saint Martin (French -Part). Users who need a "safer" option can use: -`countrycode(x, "country.name", "country.name")` Note that the function -works with non-ASCII characters. Please see the Github page for -examples. - -### Usage - - countryname( - sourcevar, - destination = "country.name.en", - nomatch = NA, - warn = TRUE - ) - -### Arguments - - - - - - - - - - - - - - - - - - - - -
sourcevar

Vector which contains the codes or country names to be converted -(character or factor)

destination

Coding scheme of destination (string such as "iso3c" enclosed in -quotes ""): type ?codelist for a list of available -codes.

nomatch

When countrycode fails to find a match for the code of origin, it -fills-in the destination vector with nomatch. The default -behavior is to fill non-matching codes with NA. If -nomatch = NULL, countrycode tries to use the origin vector -to fill-in missing values in the destination vector. -nomatch must be either NULL, of length 1, or -of the same length as sourcevar.

warn

Prints unique elements from sourcevar for which no match was -found

- -### Examples - -```r -## Not run: -x <- c('Afaganisitani', 'Barbadas', 'Sverige', 'UK') -countryname(x) -countryname(x, destination = 'iso3c') - -## End(Not run) -``` - - ---- -## Get dictionary - -### Description - -Download a custom dictionary to use in the `custom_dict` argument of -`countrycode()` - -### Usage - - get_dictionary(dictionary = NULL) - -### Arguments - - - - - - - - -
dictionary

A character string that specifies the dictionary to be retrieved. -It must be one of "global_burden_of_disease", "ch_cantons", "us_states", -"exiobase3", "gtap10". If NULL, the function will print the list of -available dictionaries. Default is NULL.

- -### Value - -If a valid dictionary is specified, the function will return that -dictionary as a data.frame. If an invalid dictionary or no dictionary is -specified, the function will stop and throw an error message. - -### Examples - -```r -## Not run: -cd <- get_dictionary("us_states") -countrycode::countrycode(c("MO", "MN"), origin = "state.abb", "state.name", custom_dict = cd) - -## End(Not run) -``` - - ---- -## Guess field - -### Description - -Users sometimes do not know what kind of code or field their data -contain. This function tries to guess by comparing the similarity -between a user-supplied vector and all the codes included in the -`countrycode` dictionary. - -### Usage - - guess_field(codes, min_similarity = 80) - -### Arguments - - - - - - - - - - - - -
codes

a vector of country codes or country names

min_similarity

the function returns all field names where over than -min_similarity% of codes are shared between the supplied -vector and the countrycode dictionary.

- -### Examples - -```r -# Guess ISO codes -guess_field(c('DZA', 'CAN', 'DEU')) - -# Guess country names -guess_field(c('Guinea','Iran','Russia','North Korea',rep('Ivory Coast',50),'Scotland')) -``` - - ---- diff --git a/docs/articles/contributions.md b/docs/vignettes/contributions.md similarity index 100% rename from docs/articles/contributions.md rename to docs/vignettes/contributions.md diff --git a/docs/articles/contributions.qmd b/docs/vignettes/contributions.qmd similarity index 100% rename from docs/articles/contributions.qmd rename to docs/vignettes/contributions.qmd diff --git a/docs/articles/countrycode.md b/docs/vignettes/countrycode.md similarity index 95% rename from docs/articles/countrycode.md rename to docs/vignettes/countrycode.md index c18b1ea..a977928 100644 --- a/docs/articles/countrycode.md +++ b/docs/vignettes/countrycode.md @@ -65,22 +65,22 @@ df1 ``` cowcodes var1 - 1 ALG 185 - 2 ALB 375 - 3 UKG 382 - 4 CAN 313 - 5 USA 149 + 1 ALG 417 + 2 ALB 135 + 3 UKG 298 + 4 CAN 132 + 5 USA 125 ``` r df2 ``` isocodes var2 - 1 12 156 - 2 8 485 - 3 826 374 - 4 124 208 - 5 840 313 + 1 12 388 + 2 8 290 + 3 826 418 + 4 124 192 + 5 840 338 Create a common variable with the iso3c code in each data frame, merge the data, and create a country identifier: @@ -94,11 +94,11 @@ df3 ``` iso3c cowcodes var1 isocodes var2 country - 1 ALB ALB 375 8 485 Albania - 2 CAN CAN 313 124 208 Canada - 3 DZA ALG 185 12 156 Algeria - 4 GBR UKG 382 826 374 United Kingdom - 5 USA USA 149 840 313 United States + 1 ALB ALB 135 8 290 Albania + 2 CAN CAN 132 124 192 Canada + 3 DZA ALG 417 12 388 Algeria + 4 GBR UKG 298 826 418 United Kingdom + 5 USA USA 125 840 338 United States ## Flags diff --git a/docs/articles/countrycode.qmd b/docs/vignettes/countrycode.qmd similarity index 100% rename from docs/articles/countrycode.qmd rename to docs/vignettes/countrycode.qmd diff --git a/docs/articles/countryname.md b/docs/vignettes/countryname.md similarity index 100% rename from docs/articles/countryname.md rename to docs/vignettes/countryname.md diff --git a/docs/articles/countryname.qmd b/docs/vignettes/countryname.qmd similarity index 100% rename from docs/articles/countryname.qmd rename to docs/vignettes/countryname.qmd diff --git a/docs/articles/custom.md b/docs/vignettes/custom.md similarity index 100% rename from docs/articles/custom.md rename to docs/vignettes/custom.md diff --git a/docs/articles/custom.qmd b/docs/vignettes/custom.qmd similarity index 100% rename from docs/articles/custom.qmd rename to docs/vignettes/custom.qmd diff --git a/man/countrycode-package.Rd b/man/countrycode-package.Rd deleted file mode 100644 index 211fa52..0000000 --- a/man/countrycode-package.Rd +++ /dev/null @@ -1,29 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/countrycode-package.R -\docType{package} -\name{countrycode-package} -\alias{countrycode-package} -\title{Convert Country Codes or Country Names} -\description{ -Convert country codes or country names -} -\details{ -The \code{countrycode} function can convert to and from several different -country coding schemes. It uses regular expressions to convert country -names (e.g. Sri Lanka) into any of those coding schemes, or into -standardized country names in several languages. It can create variables -with the name of the continent and/or several regional groupings to which -each country belongs. - -Type ?codelist to get a list of available origin and destination -codes. -} -\references{ -\if{html}{\out{
}}\preformatted{\url{http://arelbundock.com} -\url{https://github.com/vincentarelbundock/countrycode} -}\if{html}{\out{
}} -} -\author{ -Vincent Arel-Bundock \email{vincent.arel-bundock@umontreal.ca} -} -\keyword{package} diff --git a/man/countrycode.Rd b/man/countrycode.Rd index 0a9d4dd..1bb9afd 100644 --- a/man/countrycode.Rd +++ b/man/countrycode.Rd @@ -109,6 +109,7 @@ countryname(x, destination = "cowc", warn = FALSE) countryname(x, destination = "cowc", warn = FALSE, nomatch = x) \dontrun{ + library(countrycode) # Download the dictionary of US states from Github state_dict <- "https://raw.githubusercontent.com/vincentarelbundock/countrycode/main/data/custom_dictionaries/data_us_states.csv"