Update readme

ropensci · Jul 30, 2019 · cf0d881 · cf0d881
1 parent 6d87556
commit cf0d881
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 36 deletions.
diff --git a/CRAN-RELEASE b/CRAN-RELEASE
@@ -1,2 +1,2 @@
-This package was submitted to CRAN on 2019-05-18.
-Once it is accepted, delete this file and tag the release (commit c066f395e5).
+This package was submitted to CRAN on 2019-07-29.
+Once it is accepted, delete this file and tag the release (commit 6d875561c2).
diff --git a/README.Rmd b/README.Rmd
@@ -77,7 +77,7 @@ plot(travel_network, lwd = w)
 ```
 
 
-`stplanr` has many functions for working with OD data.
+**stplanr** has many functions for working with OD data.
 See the [`stplanr-od`](https://docs.ropensci.org/stplanr/articles/stplanr-od.html) vignette for details.
 
 The package can also allocate flows to the road network, e.g. with [CycleStreets.net](https://www.cyclestreets.net/api/) and the OpenStreetMap Routing Machine ([OSRM](https://github.com/Project-OSRM/osrm-backend)) API interfaces.
@@ -139,7 +139,7 @@ The resulting route network, with segment totals calculated from overlapping par
 plot(rnet["foot"], lwd = rnet$foot)
 ```
 
-The above plot represents the number of people who walk along particular routes (assuming the routes represent real routes).
+The above plot represents the number walking trips made (the 'flow') along particular segments of a transport network.
 
 <!-- (results not shown): -->
 
@@ -152,13 +152,17 @@ leaflet(data = rnet) %>%
   addLegend(pal = pal, values = ~all)
 ```
 
-## Policy and research applications
+## Policy applications
 
-The example results may not seem particularly revolutionary.
+The examples shown above, based on tiny demonstration datasets, may not seem particularly revolutionary.
 At the city scale, however, this type of analysis can be used to inform sustainable transport policies, as described in papers [describing the Propensity to Cycle Tool](https://www.jtlu.org/index.php/jtlu/article/view/862/859) (PCT), and its [application to calculate cycling to school potential](https://www.sciencedirect.com/science/article/pii/S2214140518301257) across England.
-In essence, stplanr was designed to help answer research and policy questions of the type raised in those papers.
 
-There are many other research applications that the functions in `stplanr` can help solve, most of which have yet to be thought of.
+Results generated by **stplanr** are now part of national government policy: the PCT is the recommended tool for local and regional authorities developing strategic cycle network under the Cycling and Walking Infrastructure Strategy ([CWIS](https://www.gov.uk/government/publications/cycling-and-walking-investment-strategy)), which is part of the Infrastructure Act [2015](http://www.legislation.gov.uk/ukpga/2015/7/contents/enacted).
+**stplanr** is helping dozens of local authorities across the UK to answer the question: where to prioritise investment in cycling?
+In essence, stplanr was designed to support sustainable transport policies.
+
+There are many other research and policy questions that functions in **stplanr**, and other open source software libraries and packages, can help answer.
+At a time of climate, health and social crises, it is important that technology is not only sustainable itself (e.g. as enabled by open source communities and licenses) but that it contributes to a sustainable future.
 
 ## Installation
 
@@ -226,15 +230,15 @@ Transport planning is a relatively new field of application in R.
 However, there are already some good resources on the topic, including (any further suggestions: welcome):
 
 - The Transport chapter of *Geocomputation with R*, which provides a broad introduction from a geographic data perspective: https://geocompr.robinlovelace.net/transport.html
-- The `stplanr` paper, which describes the context in which the package was developed: https://journal.r-project.org/archive/2018/RJ-2018-053/index.html (please cite this if you use `stplanr` in your work)
+- The **stplanr** paper, which describes the context in which the package was developed: https://journal.r-project.org/archive/2018/RJ-2018-053/index.html (please cite this if you use **stplanr** in your work)
 - The `dodgr` vignette, which provides an introduction to routing in R: https://cran.r-project.org/package=dodgr/vignettes/dodgr.html
 
 ## Meta
 
 * Please report issues, feature requests and questions to the [github issue tracker](https://github.com/ropensci/stplanr/issues)
 * License: MIT
-* Get citation information for `stplanr` in R doing `citation(package = 'stplanr')`
-* This project is released with a [Contributor Code of Conduct](CONDUCT.md).
+* Get citation information for **stplanr** in R doing `citation(package = 'stplanr')`
+* This project is released with a [Contributor Code of Conduct](https://github.com/ropensci/stplanr/blob/master/CONDUCT.md).
 By participating in this project you agree to abide by its terms.
 
 [![rofooter](http://ropensci.org/public_images/github_footer.png)](http://ropensci.org)
diff --git a/README.md b/README.md
@@ -92,7 +92,7 @@ plot(travel_network, lwd = w)
 
 <img src="man/figures/README-plot1-1.png" width="100%" />
 
-`stplanr` has many functions for working with OD data. See the
+**stplanr** has many functions for working with OD data. See the
 [`stplanr-od`](https://docs.ropensci.org/stplanr/articles/stplanr-od.html)
 vignette for details.
 
@@ -145,11 +145,11 @@ on the transport system, as demonstrated in the following code chunk.
 ``` r
 routes$foot <- desire_lines$foot
 rnet <- overline2(routes, attrib = "foot")
-#> 2019-07-29 21:11:32 constructing segments
-#> 2019-07-29 21:11:33 building geometry
-#> 2019-07-29 21:11:33 simplifying geometry
-#> 2019-07-29 21:11:33 aggregating flows
-#> 2019-07-29 21:11:33 rejoining segments into linestrings
+#> 2019-07-30 06:42:22 constructing segments
+#> 2019-07-30 06:42:22 building geometry
+#> 2019-07-30 06:42:22 simplifying geometry
+#> 2019-07-30 06:42:22 aggregating flows
+#> 2019-07-30 06:42:22 rejoining segments into linestrings
 ```
 
 The resulting route network, with segment totals calculated from
@@ -162,24 +162,39 @@ plot(rnet["foot"], lwd = rnet$foot)
 
 <img src="man/figures/README-unnamed-chunk-6-1.png" width="100%" />
 
-The above plot represents the number of people who walk along particular
-routes (assuming the routes represent real routes).
+The above plot represents the number walking trips made (the ‘flow’)
+along particular segments of a transport network.
 
 <!-- (results not shown): -->
 
-## Policy and research applications
+## Policy applications
 
-The example results may not seem particularly revolutionary. At the city
-scale, however, this type of analysis can be used to inform sustainable
-transport policies, as described in papers [describing the Propensity to
-Cycle Tool](https://www.jtlu.org/index.php/jtlu/article/view/862/859)
-(PCT), and its [application to calculate cycling to school
+The examples shown above, based on tiny demonstration datasets, may not
+seem particularly revolutionary. At the city scale, however, this type
+of analysis can be used to inform sustainable transport policies, as
+described in papers [describing the Propensity to Cycle
+Tool](https://www.jtlu.org/index.php/jtlu/article/view/862/859) (PCT),
+and its [application to calculate cycling to school
 potential](https://www.sciencedirect.com/science/article/pii/S2214140518301257)
-across England. In essence, stplanr was designed to help answer research
-and policy questions of the type raised in those papers.
-
-There are many other research applications that the functions in
-`stplanr` can help solve, most of which have yet to be thought of.
+across England.
+
+Results generated by **stplanr** are now part of national government
+policy: the PCT is the recommended tool for local and regional
+authorities developing strategic cycle network under the Cycling and
+Walking Infrastructure Strategy
+([CWIS](https://www.gov.uk/government/publications/cycling-and-walking-investment-strategy)),
+which is part of the Infrastructure Act
+[2015](http://www.legislation.gov.uk/ukpga/2015/7/contents/enacted).
+**stplanr** is helping dozens of local authorities across the UK to
+answer the question: where to prioritise investment in cycling? In
+essence, stplanr was designed to support sustainable transport policies.
+
+There are many other research and policy questions that functions in
+**stplanr**, and other open source software libraries and packages, can
+help answer. At a time of climate, health and social crises, it is
+important that technology is not only sustainable itself (e.g. as
+enabled by open source communities and licenses) but that it contributes
+to a sustainable future.
 
 ## Installation
 
@@ -236,10 +251,10 @@ However, there are already some good resources on the topic, including
   - The Transport chapter of *Geocomputation with R*, which provides a
     broad introduction from a geographic data perspective:
     <https://geocompr.robinlovelace.net/transport.html>
-  - The `stplanr` paper, which describes the context in which the
+  - The **stplanr** paper, which describes the context in which the
     package was developed:
     <https://journal.r-project.org/archive/2018/RJ-2018-053/index.html>
-    (please cite this if you use `stplanr` in your work)
+    (please cite this if you use **stplanr** in your work)
   - The `dodgr` vignette, which provides an introduction to routing in
     R: <https://cran.r-project.org/package=dodgr/vignettes/dodgr.html>
 
@@ -248,11 +263,11 @@ However, there are already some good resources on the topic, including
   - Please report issues, feature requests and questions to the [github
     issue tracker](https://github.com/ropensci/stplanr/issues)
   - License: MIT
-  - Get citation information for `stplanr` in R doing `citation(package
-    = 'stplanr')`
+  - Get citation information for **stplanr** in R doing
+    `citation(package = 'stplanr')`
   - This project is released with a [Contributor Code of
-    Conduct](CONDUCT.md). By participating in this project you agree to
-    abide by its
+    Conduct](https://github.com/ropensci/stplanr/blob/master/CONDUCT.md).
+    By participating in this project you agree to abide by its
 terms.
 
 [![rofooter](http://ropensci.org/public_images/github_footer.png)](http://ropensci.org)