Skip to content

Commit 51211ba

Browse files
authored
Add citation info to README (#87)
resolves #86
2 parents 6084e1a + 52ff95d commit 51211ba

File tree

4 files changed

+48
-3
lines changed

4 files changed

+48
-3
lines changed

NEWS.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# [unreleased]
22

3+
* Add citation information to README, see [Issue #86](https://github.com/pdil/usmap/issues/86).
34

45
# usmap 0.7.0
56
Released Saturday, January 20, 2024.

README.Rmd

+11
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,17 @@ data %>% rowwise %>% mutate(fips = fips(state, county))
249249

250250
## Additional Information
251251

252+
### Citation Information
253+
254+
The images generated by `usmap` are not under any copyright restrictions and may be used and distributed freely in any publication or otherwise.
255+
256+
The underlying shapefiles used to generate the map data are derived from the [US Census Bureau's TIGER/Line Shapefiles](https://www.census.gov/geographies/mapping-files/time-series/geo/tiger-line-file.2022.html#list-tab-790442341) which are not copyrighted but do suggest citation. See [section 1.2 of this document](https://www2.census.gov/geo/pdfs/maps-data/data/tiger/tgrshp2022/TGRSHP2022_TechDoc_Ch1.pdf).
257+
258+
If you wish to cite `usmap` in a publication (appreciated but never required!), you may do so in the following way:
259+
```{r citation}
260+
citation("usmap")
261+
```
262+
252263
### Coordinate System
253264

254265
`usmap` uses the [US National Atlas Equal Area](https://epsg.io/9311) coordinate system:

README.md

+33
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,39 @@ data %>% rowwise %>% mutate(fips = fips(state, county))
250250

251251
## Additional Information
252252

253+
### Citation Information
254+
255+
The images generated by `usmap` are not under any copyright restrictions
256+
and may be used and distributed freely in any publication or otherwise.
257+
258+
The underlying shapefiles used to generate the map data are derived from
259+
the [US Census Bureau’s TIGER/Line
260+
Shapefiles](https://www.census.gov/geographies/mapping-files/time-series/geo/tiger-line-file.2022.html#list-tab-790442341)
261+
which are not copyrighted but do suggest citation. See [section 1.2 of
262+
this
263+
document](https://www2.census.gov/geo/pdfs/maps-data/data/tiger/tgrshp2022/TGRSHP2022_TechDoc_Ch1.pdf).
264+
265+
If you wish to cite `usmap` in a publication (appreciated but never
266+
required!), you may do so in the following way:
267+
268+
``` r
269+
citation("usmap")
270+
#> To cite package 'usmap' in publications use:
271+
#>
272+
#> Di Lorenzo P (2024). _usmap: US Maps Including Alaska and Hawaii_. R
273+
#> package version 0.7.0, <https://CRAN.R-project.org/package=usmap>.
274+
#>
275+
#> A BibTeX entry for LaTeX users is
276+
#>
277+
#> @Manual{,
278+
#> title = {usmap: US Maps Including Alaska and Hawaii},
279+
#> author = {Paolo {Di Lorenzo}},
280+
#> year = {2024},
281+
#> note = {R package version 0.7.0},
282+
#> url = {https://CRAN.R-project.org/package=usmap},
283+
#> }
284+
```
285+
253286
### Coordinate System
254287

255288
`usmap` uses the [US National Atlas Equal Area](https://epsg.io/9311)

vignettes/usmap3.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
<meta name="author" content="Paolo Di Lorenzo" />
1414

15-
<meta name="date" content="2024-01-19" />
15+
<meta name="date" content="2024-01-23" />
1616

1717
<title>3. Advanced Mapping</title>
1818

@@ -340,12 +340,12 @@
340340

341341
<h1 class="title toc-ignore">3. Advanced Mapping</h1>
342342
<h4 class="author">Paolo Di Lorenzo</h4>
343-
<h4 class="date">2024-01-19</h4>
343+
<h4 class="date">2024-01-23</h4>
344344

345345

346346

347347
<p>This vignette will explore some of the more advanced mapping features
348-
of <code>usmap</code>. Before continuing, be sure to check out <a href="mapping.html">Mapping the US</a> as that will cover more of the
348+
of <code>usmap</code>. Before continuing, be sure to check out <a href="usmap2.html">Mapping the US</a> as that will cover more of the
349349
basics of plotting US maps and styling them with
350350
<code>ggplot2</code>.</p>
351351
<div id="labels" class="section level2">

0 commit comments

Comments
 (0)