Examples corrected in inportLCZraster

Typos corrected in paper.md Some typos corrected in the vignettes Several references added to paper.md
MGousseff · Oct 18, 2023 · 98637b1 · 98637b1
1 parent ca6c8ee
commit 98637b1
Show file tree

Hide file tree

Showing 9 changed files with 324 additions and 274 deletions.
diff --git a/.github/CODE_OF_CONDUCT.md → CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md → CODE_OF_CONDUCT.md
diff --git a/.github/CONTRIBUTING.md → CONTRIBUTING.md b/.github/CONTRIBUTING.md → CONTRIBUTING.md
diff --git a/R/importLCZraster.R b/R/importLCZraster.R
@@ -20,11 +20,21 @@
 #'
 #' @examples
 #' redonBbox<-importLCZvect(dirPath=paste0(system.file("extdata", package = "lczexplore"),
-#' "/bdtopo_2_2/Redon"), file="rsu_lcz.geojson",column="LCZ_PRIMARY", output="bBox")
+#' "/bdtopo_2_2/Redon"), file="rsu_lcz.geojson", column="LCZ_PRIMARY", output="bBox")
 #'
 #' redonWudapt<-importLCZraster(system.file("extdata", package = "lczexplore"),
 #' fileName="redonWudapt.tif",bBox=redonBbox)
 #' 
+#' # another way to get the bounding box when one explores a given city would be the use of the 
+#' # getbb() function from the osmdata package. 
+#' # This exaample requires the osmdata package and therefore is not executed here
+#' # redonBbox<-osmdata::getbb("Redon")
+#' # redonWudapt<-importLCZraster(system.file("extdata", package = "lczexplore"),
+#' # fileName="redonWudapt.tif",bBox=redonBbox)
+#' 
+#' # another way to get the bounding box when one doesn't want to compare to a vector map is to enter it's coordinates 
+#' # and feed them to st_bbox() of the sf package. 
+#' 
 #' # the following example can only be executed when user has downloaded 
 #' # CONUS-wide LCZ map and Training Areas on WUDAPT website
 #' # sanDiegobBoxCoord<-st_sf(a=1:2, geom=st_sfc(
@@ -37,7 +47,7 @@
 #' #fileName="CONUS_LCZ_map_NLCD_v1.0_epsg4326.tif",
 #' #column="CONUS_LCZ_map_NLCD_v1.0_epsg4326"
 #' #  ,bBox=sanDiegoBbox)
-#' #showLCZ(sanDiegoWudapt,column="CONUS_LCZ_map_NLCD_v1.0_epsg4326")
+#' #showLCZ(sanDiegoWudapt, column="CONUS_LCZ_map_NLCD_v1.0_epsg4326")
 importLCZraster<-function(dirPath,zone="europe",bBox,fileName="EU_LCZ_map.tif", column='EU_LCZ_map',
                           typeLevels=c("1"="1","2"="2","3"="3","4"="4","5"="5","6"="6","7"="7","8"="8",
                            "9"="9","10"="10","101"="11","102"="12","103"="13","104"="14",

diff --git a/docs/articles/joss/paper.bib b/docs/articles/joss/paper.bib
@@ -154,36 +154,36 @@ @article{chingWUDAPTUrbanWeather2018a
   issn = {0003-0007, 1520-0477},
   doi = {10.1175/BAMS-D-16-0236.1},
   urldate = {2023-06-30},
-  }
-  
-  @article{cohenCoefficientAgreementNominal1960,
-    title = {A {{Coefficient}} of {{Agreement}} for {{Nominal Scales}}},
-    author = {Cohen, Jacob},
-    year = {1960},
-    month = apr,
-    journal = {Educational and Psychological Measurement},
-    volume = {20},
-    number = {1},
-    pages = {37--46},
-    issn = {0013-1644, 1552-3888},
-    doi = {10.1177/001316446002000104},
-    urldate = {2023-06-30},
-    langid = {english}
-  }
-  
-  @article{demuzereLCZGeneratorWeb2021,
-    title = {{{LCZ Generator}}: {{A Web Application}} to {{Create Local Climate Zone Maps}}},
-    shorttitle = {{{LCZ Generator}}},
-    author = {Demuzere, Matthias and Kittner, Jonas and Bechtel, Benjamin},
-    year = {2021},
-    month = apr,
-    journal = {Frontiers in Environmental Science},
-    volume = {9},
-    pages = {637455},
-    issn = {2296-665X},
-    doi = {10.3389/fenvs.2021.637455},
-    urldate = {2023-06-30},
-    }
+}
+
+@article{cohenCoefficientAgreementNominal1960,
+  title = {A {{Coefficient}} of {{Agreement}} for {{Nominal Scales}}},
+  author = {Cohen, Jacob},
+  year = {1960},
+  month = apr,
+  journal = {Educational and Psychological Measurement},
+  volume = {20},
+  number = {1},
+  pages = {37--46},
+  issn = {0013-1644, 1552-3888},
+  doi = {10.1177/001316446002000104},
+  urldate = {2023-06-30},
+  langid = {english}
+}
+
+@article{demuzereLCZGeneratorWeb2021,
+  title = {{{LCZ Generator}}: {{A Web Application}} to {{Create Local Climate Zone Maps}}},
+  shorttitle = {{{LCZ Generator}}},
+  author = {Demuzere, Matthias and Kittner, Jonas and Bechtel, Benjamin},
+  year = {2021},
+  month = apr,
+  journal = {Frontiers in Environmental Science},
+  volume = {9},
+  pages = {637455},
+  issn = {2296-665X},
+  doi = {10.3389/fenvs.2021.637455},
+  urldate = {2023-06-30},
+}
 
 @techreport{bernardGenericAlgorithmAutomatically2023,
   type = {Preprint},
@@ -235,4 +235,37 @@ @article{RJ-2018-009
   pages = {439--446},
   volume = {10},
   number = {1}
+}
+
+
+@article{demuzere2019mapping,
+  title={Mapping Europe into local climate zones},
+  author={Demuzere, Matthias and Bechtel, Benjamin and Middel, Ariane and Mills, Gerald},
+  journal={PloS one},
+  volume={14},
+  number={4},
+  pages={e0214474},
+  year={2019},
+  publisher={Public Library of Science San Francisco, CA USA}
+}
+
+@article{demuzere2022global,
+  title={A global map of Local Climate Zones to support earth system modelling and urban scale environmental science},
+  author={Demuzere, Matthias and Kittner, Jonas and Martilli, Alberto and Mills, Gerald and Moede, Christian and Stewart, Iain D and van Vliet, Jasper and Bechtel, Benjamin},
+  journal={Earth System Science Data Discussions},
+  volume={2022},
+  pages={1--57},
+  year={2022},
+  publisher={G{\"o}ttingen, Germany}
+}
+
+@article{demuzere2020combining,
+  title={Combining expert and crowd-sourced training data to map urban form and functions for the continental US},
+  author={Demuzere, Matthias and Hankey, Steve and Mills, Gerald and Zhang, Wenwen and Lu, Tianjun and Bechtel, Benjamin},
+  journal={Scientific data},
+  volume={7},
+  number={1},
+  pages={264},
+  year={2020},
+  publisher={Nature Publishing Group UK London}
 }