Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ratnanil committed Feb 1, 2021
1 parent 2a0267e commit 9475cf8
Showing 1 changed file with 21 additions and 11 deletions.
32 changes: 21 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,32 @@
# spatialR_for_ArcGIS_Users
Work in Progress: A resource for people transitioning from ArcGIS to R for spatial stuff


### General rule

- following the approach of presenting the __respective ArcGIS solutions__ to the sample R examples
- consequently, providing the links to the esri resourses seems quite meaningfull
Work in Progress: A resource for people transitioning from ArcGIS to R for spatial stuff


### Some basic text formatting rules for keeping the document consistent.
## Some basic text formatting rules for keeping the document consistent.

- formatting with __bold__, in the following cases:
- package name (e.g __sf__)
- operation (e.g __spatial subsetting__)
- dataset name (e.g __parking spots in the canton of Zurich__)

- formatting with _italics_, in the following cases:
- function name (e.g _st_buffer_)
- referring to a tool (e.g `Select By Attributes`)
- operation (e.g __spatial subsetting__)


- formatting with this `format`, in the following cases:
- referring to a tool (e.g `Select By Attributes`)
- package name (e.g __sf__)
- function name (e.g _st_buffer_)



## Dependencies

To capture the various dependencies on r-Packages, we follow the following logic (see also https://github.com/arc2r/book/issues/9):



| Priority | Dependency (Package Necessary to:) | File | Repo | Field | Eg. |
|---------- |----------------------------------------------- |------------- |------------- |---------- |--------------------- |
| 1 | Use the **data-package** | DESCRIPTION | arc2r/arc2r | Imports | `sf`, `raster` |
| 2 | To run the code described within **the book** | DESCRIPTION | arc2r/arc2r | Suggests | `gstat`, `tmap`, `dplyr` |
| 3 | Render **the book** | DESCRIPTION | arc2r/book | Imports | `bookdown`, `rmarkdown` |

0 comments on commit 9475cf8

Please sign in to comment.