Skip to content

Commit f52a9df

Browse files
committed
JOSS update
1 parent 6e48431 commit f52a9df

File tree

5 files changed

+70
-49
lines changed

5 files changed

+70
-49
lines changed

‎README.Rmd‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ output: rmarkdown::github_document
1010
[![](https://badges.ropensci.org/176_status.svg)](https://github.com/ropensci/software-review/issues/176)
1111
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/)
1212
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/PostcodesioR)](https://cran.r-project.org/package=PostcodesioR)
13-
[![DOI](https://zenodo.org/badge/64221541.svg)](https://zenodo.org/badge/latestdoi/64221541)
13+
[![DOI](https://joss.theoj.org/papers/10.21105/joss.05334/status.svg)](https://doi.org/10.21105/joss.05334)
1414
![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/PostcodesioR)
1515

1616
An API wrapper around [postcodes.io](https://postcodes.io/) - free UK postcode lookup and geocoder. This package helps to find and transform information about UK administrative geography like postcodes, LSOA, MSOA, constituencies, counties, wards, districts, CCG or NUTS.
@@ -67,16 +67,20 @@ Check the [vignette](https://docs.ropensci.org/PostcodesioR/articles/Introductio
6767

6868
Please cite this package if it is used in a publication
6969

70-
`Walczak, E. (2021). PostcodesioR: API Wrapper Around 'Postcodes.io'. R package version 0.3.1, https://cran.r-project.org/web/packages/PostcodesioR/.`
70+
`Walczak, E. J., (2023). PostcodesioR: An R package for UK geocoding. Journal of Open Source Software, 8(84), 5334, https://doi.org/10.21105/joss.05334`
7171

7272
BibTeX entry is here:
7373

7474
```{latex, echo=TRUE, eval=FALSE}
75-
@Manual{,
76-
title = {PostcodesioR: API Wrapper Around Postcodes.io},
77-
author = {Eryk Walczak},
78-
year = {2021},
79-
doi = {10.5281/zenodo.5717210},
75+
@article{postcodesior:2023,
76+
title = {{PostcodesioR: An R package for UK geocoding}},
77+
author = {Eryk J. Walczak},
78+
journal = {Journal of Open Source Software},
79+
volume = {8},
80+
number = {84},
81+
pages = {5334},
82+
year = {2023},
83+
doi = {10.21105/joss.05334},
8084
note = {R package version 0.3.1},
8185
url = {https://cran.r-project.org/web/packages/PostcodesioR/},
8286
}

‎README.md‎

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Status](https://travis-ci.org/ropensci/PostcodesioR.svg?branch=master)](https://
1010
[![Project Status: Active – The project has reached a stable, usable
1111
state and is being actively
1212
developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/)
13-
[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/PostcodesioR)](https://cran.r-project.org/package=PostcodesioR)
14-
[![DOI](https://zenodo.org/badge/64221541.svg)](https://zenodo.org/badge/latestdoi/64221541)
13+
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/PostcodesioR)](https://cran.r-project.org/package=PostcodesioR)
14+
[![DOI](https://joss.theoj.org/papers/10.21105/joss.05334/status.svg)](https://doi.org/10.21105/joss.05334)
1515
![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/PostcodesioR)
1616

1717
An API wrapper around [postcodes.io](https://postcodes.io/) - free UK
@@ -77,7 +77,7 @@ lookup_result <- postcode_lookup("EC1Y8LX")
7777
str(lookup_result)
7878
```
7979

80-
## 'data.frame': 1 obs. of 35 variables:
80+
## 'data.frame': 1 obs. of 38 variables:
8181
## $ postcode : chr "EC1Y 8LX"
8282
## $ quality : int 1
8383
## $ eastings : int 532544
@@ -97,13 +97,15 @@ str(lookup_result)
9797
## $ admin_district : chr "Islington"
9898
## $ parish : chr "Islington, unparished area"
9999
## $ admin_county : logi NA
100+
## $ date_of_introduction : chr "198001"
100101
## $ admin_ward : chr "Bunhill"
101102
## $ ced : logi NA
102103
## $ ccg : chr "NHS North Central London"
103104
## $ nuts : chr "Haringey and Islington"
105+
## $ pfa : chr "Metropolitan Police"
104106
## $ admin_district_code : chr "E09000019"
105107
## $ admin_county_code : chr "E99999999"
106-
## $ admin_ward_code : chr "E05000367"
108+
## $ admin_ward_code : chr "E05013699"
107109
## $ parish_code : chr "E43000209"
108110
## $ parliamentary_constituency_code: chr "E14000764"
109111
## $ ccg_code : chr "E38000240"
@@ -113,6 +115,7 @@ str(lookup_result)
113115
## $ lsoa_code : chr "E01002704"
114116
## $ msoa_code : chr "E02000576"
115117
## $ lau2_code : chr "E09000019"
118+
## $ pfa_code : chr "E23000001"
116119

117120
Check the
118121
[vignette](https://docs.ropensci.org/PostcodesioR/articles/Introduction.html)
@@ -122,16 +125,20 @@ to see all functions in action.
122125

123126
Please cite this package if it is used in a publication
124127

125-
`Walczak, E. (2021). PostcodesioR: API Wrapper Around 'Postcodes.io'. R package version 0.3.1, https://cran.r-project.org/web/packages/PostcodesioR/.`
128+
`Walczak, E. J., (2023). PostcodesioR: An R package for UK geocoding. Journal of Open Source Software, 8(84), 5334, https://doi.org/10.21105/joss.05334`
126129

127130
BibTeX entry is here:
128131

129132
``` latex
130-
@Manual{,
131-
title = {PostcodesioR: API Wrapper Around Postcodes.io},
132-
author = {Eryk Walczak},
133-
year = {2021},
134-
doi = {10.5281/zenodo.5717210},
133+
@article{postcodesior:2023,
134+
title = {{PostcodesioR: An R package for UK geocoding}},
135+
author = {Eryk J. Walczak},
136+
journal = {Journal of Open Source Software},
137+
volume = {8},
138+
number = {84},
139+
pages = {5334},
140+
year = {2023},
141+
doi = {10.21105/joss.05334},
135142
note = {R package version 0.3.1},
136143
url = {https://cran.r-project.org/web/packages/PostcodesioR/},
137144
}
@@ -157,4 +164,4 @@ Please note that this project is released with a [Contributor Code of
157164
Conduct](https://github.com/ropensci/PostcodesioR/blob/master/CONDUCT.md).
158165
By participating in this project you agree to abide by its terms.
159166

160-
[![ropensci\_footer](https://ropensci.org/public_images/ropensci_footer.png)](https://ropensci.org)
167+
[![ropensci_footer](https://ropensci.org/public_images/ropensci_footer.png)](https://ropensci.org)

‎docs/CONDUCT.html‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/authors.html‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/index.html‎

Lines changed: 38 additions & 29 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)