diff --git a/pkgdown.yml b/pkgdown.yml index 56719bf..ec4f5f0 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 3.1.11 pkgdown: 2.0.9 pkgdown_sha: ~ articles: {} -last_built: 2024-04-30T15:06Z +last_built: 2024-04-30T15:28Z urls: reference: https://nptscot.github.io/corenet/reference article: https://nptscot.github.io/corenet/articles diff --git a/reference/get_edinburgh_6km.html b/reference/get_edinburgh_6km.html new file mode 100644 index 0000000..d415681 --- /dev/null +++ b/reference/get_edinburgh_6km.html @@ -0,0 +1,92 @@ + +Get the Edinburgh road network, within radius of 6 km of the center — get_edinburgh_6km • corenet + Skip to contents + + +
+
+
+

Get the Edinburgh road network, within radius of 6 km of the center

+ +
get_edinburgh_6km.Rd
+
+ +
+

Get the Edinburgh road network, within radius of 6 km of the center

+
+ +
+

Usage

+ 
get_edinburgh_6km()
+
+ + +
+

Examples

+ 
get_edinburgh_6km()
+#> Simple feature collection with 12096 features and 4 fields
+#> Geometry type: LINESTRING
+#> Dimension:     XY
+#> Bounding box:  xmin: 319899.7 ymin: 668038.5 xmax: 331833.5 ymax: 677990.9
+#> Projected CRS: OSGB36 / British National Grid
+#> # A tibble: 12,096 × 5
+#>    name  road_function form_of_way road_classification                      geom
+#>    <chr> <chr>         <chr>       <chr>                        <LINESTRING [m]>
+#>  1 NA    Restricted L… Single Car… Unknown             (321210.7 676718.5, 3211…
+#>  2 Ferr… Local Road    Single Car… Unclassified        (324017 676022, 324034 6…
+#>  3 West… Local Road    Single Car… Unclassified        (329693 674189, 329672.5…
+#>  4 Caiy… Local Road    Single Car… Unclassified        (324258 668416, 324255.5…
+#>  5 Logi… Restricted L… Single Car… Not Classified      (325559 675412, 325547.5…
+#>  6 Prin… Local Road    Single Car… Unclassified        (329750.7 670697.9, 3297…
+#>  7 Morn… A Road        Single Car… A Road              (324532 671199, 324530.5…
+#>  8 Rose… Local Road    Single Car… Unclassified        (323197 672989, 323207 6…
+#>  9 Char… Local Road    Single Car… Unclassified        (325917 673020, 325914.5…
+#> 10 Home… A Road        Collapsed … A Road              (324910.8 672963.1, 3249…
+#> # ℹ 12,086 more rows
+
+
+
+ + +
+ + + + + + + diff --git a/reference/index.html b/reference/index.html index c003c3d..c8dfca6 100644 --- a/reference/index.html +++ b/reference/index.html @@ -50,6 +50,16 @@

All functionscorenet()
Generate a core network from road network data
+
+ + get_edinburgh_6km() +
+
Get the Edinburgh road network, within radius of 6 km of the center
+
+ + os_edinburgh_demo +
+
Data from OS Open Roads, Edinburgh, 3 km radius
diff --git a/reference/os_edinburgh_demo.html b/reference/os_edinburgh_demo.html new file mode 100644 index 0000000..2c0bc84 --- /dev/null +++ b/reference/os_edinburgh_demo.html @@ -0,0 +1,93 @@ + +Data from OS Open Roads, Edinburgh, 3 km radius — os_edinburgh_demo • corenet + Skip to contents + + +
+
+
+

Data from OS Open Roads, Edinburgh, 3 km radius

+ +
os_edinburgh_demo.Rd
+
+ +
+

Data from OS Open Roads, Edinburgh, 3 km radius

+
+ + +
+

Format

+

An sf data frame

+
+ +
+

Examples

+ 
library(sf)
+#> Linking to GEOS 3.10.2, GDAL 3.4.1, PROJ 8.2.1; sf_use_s2() is TRUE
+# TODO: fix this
+# data(os_edinburgh_demo)
+# names(os_edinburgh_demo)
+os_edinburgh = get_edinburgh_6km()
+head(os_edinburgh)
+#> Simple feature collection with 6 features and 4 fields
+#> Geometry type: LINESTRING
+#> Dimension:     XY
+#> Bounding box:  xmin: 321165.6 ymin: 668416 xmax: 329764.5 ymax: 676718.5
+#> Projected CRS: OSGB36 / British National Grid
+#> # A tibble: 6 × 5
+#>   name   road_function form_of_way road_classification                      geom
+#>   <chr>  <chr>         <chr>       <chr>                        <LINESTRING [m]>
+#> 1 NA     Restricted L… Single Car… Unknown             (321210.7 676718.5, 3211…
+#> 2 Ferry… Local Road    Single Car… Unclassified        (324017 676022, 324034 6…
+#> 3 West … Local Road    Single Car… Unclassified        (329693 674189, 329672.5…
+#> 4 Caiys… Local Road    Single Car… Unclassified        (324258 668416, 324255.5…
+#> 5 Logie… Restricted L… Single Car… Not Classified      (325559 675412, 325547.5…
+#> 6 Pring… Local Road    Single Car… Unclassified        (329750.7 670697.9, 3297…
+
+
+
+ + +
+

Developed by First Last.

+
+ +
+

Site built with pkgdown 2.0.9.

+
+ +
+ + + + + + + diff --git a/search.json b/search.json index 3351a8d..64a763a 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":"https://nptscot.github.io/corenet/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 Zhao Wang Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://nptscot.github.io/corenet/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"First Last. Author, maintainer.","code":""},{"path":"https://nptscot.github.io/corenet/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Last F (2024). corenet: Package (One Line, Title Case). R package version 0.0.1, https://nptscot.github.io/corenet/.","code":"@Manual{, title = {corenet: What the Package Does (One Line, Title Case)}, author = {First Last}, year = {2024}, note = {R package version 0.0.1}, url = {https://nptscot.github.io/corenet/}, }"},{"path":"https://nptscot.github.io/corenet/index.html","id":"corenet","dir":"","previous_headings":"","what":"What the Package Does (One Line, Title Case)","title":"What the Package Does (One Line, Title Case)","text":"goal corenet provide set functions generate ‘core’ route networks transport planning. Install :","code":"if (!require(\"remotes\")) { install.packages(\"remotes\") } remotes::install_github(\"nptscot/corenet\")"},{"path":"https://nptscot.github.io/corenet/reference/corenet.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a core network from road network data — corenet","title":"Generate a core network from road network data — corenet","text":"Description go ...","code":""},{"path":"https://nptscot.github.io/corenet/reference/corenet.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a core network from road network data — corenet","text":"","code":"corenet(net, tbc)"},{"path":"https://nptscot.github.io/corenet/reference/corenet.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a core network from road network data — corenet","text":"net road network object, class sf tbc object determined","code":""},{"path":"https://nptscot.github.io/corenet/reference/corenet.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a core network from road network data — corenet","text":"core network object, class sf","code":""},{"path":"https://nptscot.github.io/corenet/reference/corenet.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a core network from road network data — corenet","text":"","code":"corenet() #> x y #> 1 1 2"}] +[{"path":"https://nptscot.github.io/corenet/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 Zhao Wang Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://nptscot.github.io/corenet/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"First Last. Author, maintainer.","code":""},{"path":"https://nptscot.github.io/corenet/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Last F (2024). corenet: Package (One Line, Title Case). R package version 0.0.1, https://nptscot.github.io/corenet/.","code":"@Manual{, title = {corenet: What the Package Does (One Line, Title Case)}, author = {First Last}, year = {2024}, note = {R package version 0.0.1}, url = {https://nptscot.github.io/corenet/}, }"},{"path":"https://nptscot.github.io/corenet/index.html","id":"corenet","dir":"","previous_headings":"","what":"What the Package Does (One Line, Title Case)","title":"What the Package Does (One Line, Title Case)","text":"goal corenet provide set functions generate ‘core’ route networks transport planning. Install :","code":"if (!require(\"remotes\")) { install.packages(\"remotes\") } remotes::install_github(\"nptscot/corenet\")"},{"path":"https://nptscot.github.io/corenet/reference/corenet.html","id":null,"dir":"Reference","previous_headings":"","what":"Generate a core network from road network data — corenet","title":"Generate a core network from road network data — corenet","text":"Description go ...","code":""},{"path":"https://nptscot.github.io/corenet/reference/corenet.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Generate a core network from road network data — corenet","text":"","code":"corenet(net, tbc)"},{"path":"https://nptscot.github.io/corenet/reference/corenet.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Generate a core network from road network data — corenet","text":"net road network object, class sf tbc object determined","code":""},{"path":"https://nptscot.github.io/corenet/reference/corenet.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Generate a core network from road network data — corenet","text":"core network object, class sf","code":""},{"path":"https://nptscot.github.io/corenet/reference/corenet.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Generate a core network from road network data — corenet","text":"","code":"corenet() #> x y #> 1 1 2"},{"path":"https://nptscot.github.io/corenet/reference/get_edinburgh_6km.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the Edinburgh road network, within radius of 6 km of the center — get_edinburgh_6km","title":"Get the Edinburgh road network, within radius of 6 km of the center — get_edinburgh_6km","text":"Get Edinburgh road network, within radius 6 km center","code":""},{"path":"https://nptscot.github.io/corenet/reference/get_edinburgh_6km.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the Edinburgh road network, within radius of 6 km of the center — get_edinburgh_6km","text":"","code":"get_edinburgh_6km()"},{"path":"https://nptscot.github.io/corenet/reference/get_edinburgh_6km.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get the Edinburgh road network, within radius of 6 km of the center — get_edinburgh_6km","text":"","code":"get_edinburgh_6km() #> Simple feature collection with 12096 features and 4 fields #> Geometry type: LINESTRING #> Dimension: XY #> Bounding box: xmin: 319899.7 ymin: 668038.5 xmax: 331833.5 ymax: 677990.9 #> Projected CRS: OSGB36 / British National Grid #> # A tibble: 12,096 × 5 #> name road_function form_of_way road_classification geom #> #> 1 NA Restricted L… Single Car… Unknown (321210.7 676718.5, 3211… #> 2 Ferr… Local Road Single Car… Unclassified (324017 676022, 324034 6… #> 3 West… Local Road Single Car… Unclassified (329693 674189, 329672.5… #> 4 Caiy… Local Road Single Car… Unclassified (324258 668416, 324255.5… #> 5 Logi… Restricted L… Single Car… Not Classified (325559 675412, 325547.5… #> 6 Prin… Local Road Single Car… Unclassified (329750.7 670697.9, 3297… #> 7 Morn… A Road Single Car… A Road (324532 671199, 324530.5… #> 8 Rose… Local Road Single Car… Unclassified (323197 672989, 323207 6… #> 9 Char… Local Road Single Car… Unclassified (325917 673020, 325914.5… #> 10 Home… A Road Collapsed … A Road (324910.8 672963.1, 3249… #> # ℹ 12,086 more rows"},{"path":"https://nptscot.github.io/corenet/reference/os_edinburgh_demo.html","id":null,"dir":"Reference","previous_headings":"","what":"Data from OS Open Roads, Edinburgh, 3 km radius — os_edinburgh_demo","title":"Data from OS Open Roads, Edinburgh, 3 km radius — os_edinburgh_demo","text":"Data OS Open Roads, Edinburgh, 3 km radius","code":""},{"path":"https://nptscot.github.io/corenet/reference/os_edinburgh_demo.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"Data from OS Open Roads, Edinburgh, 3 km radius — os_edinburgh_demo","text":"sf data frame","code":""},{"path":"https://nptscot.github.io/corenet/reference/os_edinburgh_demo.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Data from OS Open Roads, Edinburgh, 3 km radius — os_edinburgh_demo","text":"","code":"library(sf) #> Linking to GEOS 3.10.2, GDAL 3.4.1, PROJ 8.2.1; sf_use_s2() is TRUE # TODO: fix this # data(os_edinburgh_demo) # names(os_edinburgh_demo) os_edinburgh = get_edinburgh_6km() head(os_edinburgh) #> Simple feature collection with 6 features and 4 fields #> Geometry type: LINESTRING #> Dimension: XY #> Bounding box: xmin: 321165.6 ymin: 668416 xmax: 329764.5 ymax: 676718.5 #> Projected CRS: OSGB36 / British National Grid #> # A tibble: 6 × 5 #> name road_function form_of_way road_classification geom #> #> 1 NA Restricted L… Single Car… Unknown (321210.7 676718.5, 3211… #> 2 Ferry… Local Road Single Car… Unclassified (324017 676022, 324034 6… #> 3 West … Local Road Single Car… Unclassified (329693 674189, 329672.5… #> 4 Caiys… Local Road Single Car… Unclassified (324258 668416, 324255.5… #> 5 Logie… Restricted L… Single Car… Not Classified (325559 675412, 325547.5… #> 6 Pring… Local Road Single Car… Unclassified (329750.7 670697.9, 3297…"}] diff --git a/sitemap.xml b/sitemap.xml index 6687413..b9cef05 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -18,7 +18,13 @@ https://nptscot.github.io/corenet/reference/corenet.html + + https://nptscot.github.io/corenet/reference/get_edinburgh_6km.html + https://nptscot.github.io/corenet/reference/index.html + + https://nptscot.github.io/corenet/reference/os_edinburgh_demo.html +