Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review rpygeo #39

Open
wants to merge 13 commits into
base: gh-pages
Choose a base branch
from
Open

Review rpygeo #39

wants to merge 13 commits into from

Conversation

be-marc
Copy link
Member

@be-marc be-marc commented Mar 10, 2019

No description provided.

@be-marc be-marc closed this Mar 10, 2019
@be-marc be-marc reopened this Mar 10, 2019
Copy link
Member

@pat-s pat-s left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe you can elaborate a bit more on the "magic" going on behind the scenes and show a small use case what is possible now.
If this is already available in the vignette, just copy-paste it here.
People will sometimes not see the vignette but only the blog post.

Adding a bit more code examples would also make reading the post more enjoyable so that it can serve as a standalone resource.


[DOWNLOADHERE]

RPyGeo 1.0.0 has been released on CRAN. The RPyGeo package establishes an interface to the geoprocessing tools of ArcGIS from within R. ArGIS is a geographic information system developed by Esri.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to ArcGIS page. Maybe change to "ArcGIS is one of the leading [...]".


[DOWNLOADHERE]

RPyGeo 1.0.0 has been released on CRAN. The RPyGeo package establishes an interface to the geoprocessing tools of ArcGIS from within R. ArGIS is a geographic information system developed by Esri.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add the release date?


RPyGeo 1.0.0 has been released on CRAN. The RPyGeo package establishes an interface to the geoprocessing tools of ArcGIS from within R. ArGIS is a geographic information system developed by Esri.

The new RPyGeo package accesses the ArcPy Python side-package via the [reticulate](https://cran.r-project.org/web/packages/reticulate/index.html) package. ArcGIS provides almost all of it's geoprocessing tools via ArcPy. With RPyGeo these functions are available in R. Additonally RPyGeo provides utilitiy functions to create a seamless workflow between ArcGIS and R.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • "The new version of the package"

  • "ArcPy Python side-package" sounds a bit strange, rephrase?

  • Put "RPygeo" in backticks or in italics

  • do a spellcheck


The new RPyGeo package accesses the ArcPy Python side-package via the [reticulate](https://cran.r-project.org/web/packages/reticulate/index.html) package. ArcGIS provides almost all of it's geoprocessing tools via ArcPy. With RPyGeo these functions are available in R. Additonally RPyGeo provides utilitiy functions to create a seamless workflow between ArcGIS and R.

In 2015 Esri released the R-ArcGIS Bridge, a software that also connects ArcGIS and R. Essentially, the R-ArcGIS Bridge offers read, write and conversion functions to transfer data from ArcGIS to R and vice versa. The idea is to use the large number of R packages to solve spatial problems, which cannot be solved with ArcGIS alone. R scripts can be run as geospatial scripts with an interactive user inferface from within ArcGIS. However, no functionality is added for the R user. RPyGeo is able to run the geoprocessing tools of ArcGIS directly from the R session.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • link to R-ArcgGIS bridge

"The idea is to use the large number of R packages to solve spatial problems"

-> sth like "to use R to add additional capabilities for solving spatial problems"

"R scripts can be run as geospatial scripts"

-> put "geospatial scripts" in parantheses or explain better what is meant by this in the context of ArcGIS

"However, no functionality is added for the R user. RPyGeo is able to run the geoprocessing tools of ArcGIS directly from the R session."

-> do you want to showcase a difference here? this does not become clear. Maybe add a bit more detail.

The new RPyGeo package accesses the ArcPy Python side-package via the [reticulate](https://cran.r-project.org/web/packages/reticulate/index.html) package. ArcGIS provides almost all of it's geoprocessing tools via ArcPy. With RPyGeo these functions are available in R. Additonally RPyGeo provides utilitiy functions to create a seamless workflow between ArcGIS and R.

In 2015 Esri released the R-ArcGIS Bridge, a software that also connects ArcGIS and R. Essentially, the R-ArcGIS Bridge offers read, write and conversion functions to transfer data from ArcGIS to R and vice versa. The idea is to use the large number of R packages to solve spatial problems, which cannot be solved with ArcGIS alone. R scripts can be run as geospatial scripts with an interactive user inferface from within ArcGIS. However, no functionality is added for the R user. RPyGeo is able to run the geoprocessing tools of ArcGIS directly from the R session.
The update added many new features to the package. It is now possible to chain ArcPy functions togheter with the pipe operator. Help files for all ArcGIS functions can be viewed directly inside RStudio. Moreover, map algebra expressions can be used to modify raster objects.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The update added many new features to the package. I

"With the new version it is now...

It is now possible to chain ArcPy functions togheter with the pipe operator

-> It is now possible to chain ArcPy functions using the pipe operator

In 2015 Esri released the R-ArcGIS Bridge, a software that also connects ArcGIS and R. Essentially, the R-ArcGIS Bridge offers read, write and conversion functions to transfer data from ArcGIS to R and vice versa. The idea is to use the large number of R packages to solve spatial problems, which cannot be solved with ArcGIS alone. R scripts can be run as geospatial scripts with an interactive user inferface from within ArcGIS. However, no functionality is added for the R user. RPyGeo is able to run the geoprocessing tools of ArcGIS directly from the R session.
The update added many new features to the package. It is now possible to chain ArcPy functions togheter with the pipe operator. Help files for all ArcGIS functions can be viewed directly inside RStudio. Moreover, map algebra expressions can be used to modify raster objects.

For a detailed instruction on how to use RPyGeo we would like to refer to the [vignette](https://cran.r-project.org/web/packages/RPyGeo/RPyGeo.pdf). It includes a tutorial with all essential RPyGeo functions.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For a detailed instruction on how to use RPyGeo we would like to refer to the vignette.

-> For a detailed instruction on how to use RPyGeo please see the corresponding vignette. (Maybe a pkgdown site would help here? But maybe problematic to generate one on Travis as we need Windows)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also the link is not to the vignette but to the reference PDF. The vignette is at https://cran.r-project.org/web/packages/RPyGeo/vignettes/RPyGeo.html

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


For a detailed instruction on how to use RPyGeo we would like to refer to the [vignette](https://cran.r-project.org/web/packages/RPyGeo/RPyGeo.pdf). It includes a tutorial with all essential RPyGeo functions.

The devolepment of RPyGeo is now integrated into the r-spatial.org community. If you find any bugs please report them at our new development repository [r-spatial/RPyGeo](https://github.com/r-spatial/RPyGeo) or help us fix them via a pull request.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The devolepment of RPyGeo is now integrated into the r-spatial.org community. If you find any bugs please report them at our new development repository r-spatial/RPyGeo or help us fix them via a pull request.

The source code of RpyGeo is now hosted on Github within the r-spatial organization.

@edzer
Copy link
Member

edzer commented Mar 30, 2019

Is this blog ready to go?

@edzer
Copy link
Member

edzer commented Mar 30, 2019

@pat-s
Copy link
Member

pat-s commented Mar 31, 2019

@edzer something went wrong here, the post is about RPyGeo and not RSAGA. The latter has been released in November 18 already. @be-marc wasn't there already a blog post about RSAGA before?
I'm on the phone right now, should check in detail in the next days.

@be-marc
Copy link
Member Author

be-marc commented Mar 31, 2019

Yes this is the old RSAGA blog post. I wrote it in March 2018.

@edzer
Copy link
Member

edzer commented Apr 1, 2019

Sorry about that. Shall I remove it?

@pat-s
Copy link
Member

pat-s commented Apr 1, 2019

No worries! Don't remove, just dating it back to its original post date is fine. I do not see the original post date anymore in the list but it should be in the git hist?

I'll try to finish the review here ASAP.

Copy link
Member

@pat-s pat-s left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the updated version! Reads much smoother now.

Please start a new sentence on a new line always - this simplifies reviewing.
Also keeping the filename static until a review is finished helps to have a diff history of the review.
Once we are good to go here, you can update the filename/post date and then it can be published.

The short comparison to the R-bridge is really valuable here.

_rmd/2019-03-11-RPyGeo-1_0_0.Rmd Outdated Show resolved Hide resolved
_rmd/2019-03-11-RPyGeo-1_0_0.Rmd Outdated Show resolved Hide resolved

RPyGeo 1.0.0 has been released on 14.11.2018 on CRAN. The RPyGeo package establishes an interface to the geoprocessing tools of ArcGIS from within R. [ArcGIS](https://www.esri.com/en-us/arcgis/about-arcgis/overview) is the leading commercial geographic information system platform, which is developed by Esri since 1999.

ArcGIS offers access to its geoprocessing tools via a Python site-package called ArcPy. The new version of RPyGeo reads the site-package via the [reticulate](https://cran.r-project.org/web/packages/reticulate/index.html) package into the R session.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is "site-package" the correct wording here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes it is

_rmd/2019-03-11-RPyGeo-1_0_0.Rmd Outdated Show resolved Hide resolved
_rmd/2019-03-11-RPyGeo-1_0_0.Rmd Outdated Show resolved Hide resolved
rpygeo_load()
```

Map algebra expressions can be used in RPyGeo with special operators to modify ArcPy raster objects. The resulting temporary files can be saved to the hard disk with the helper function `rpygeo_save()`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Helper functions are usually non-exported functions within a package.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also called them helper functions in the vignette but we could use another word and change it in all documents.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I think its not so crucial and the meaning of "helper function" is used in a manifold context. If its consistent everywhere just leave it as it is :)

_rmd/2019-03-11-RPyGeo-1_0_0.Rmd Outdated Show resolved Hide resolved
_rmd/2019-03-11-RPyGeo-1_0_0.Rmd Outdated Show resolved Hide resolved
_rmd/2019-03-11-RPyGeo-1_0_0.Rmd Outdated Show resolved Hide resolved
_rmd/2019-03-11-RPyGeo-1_0_0.Rmd Outdated Show resolved Hide resolved
be-marc and others added 3 commits June 1, 2019 13:25
@pat-s
Copy link
Member

pat-s commented Jun 1, 2019

@be-marc Good work.

Please

  • remove the outdated file from the PR
  • update the post date
  • take a final look at the post

and then we're good to go here I think 👍

@be-marc
Copy link
Member Author

be-marc commented Jun 3, 2019

@edzer Ready

@pat-s
Copy link
Member

pat-s commented Jun 17, 2019

ping @edzer

@edzer
Copy link
Member

edzer commented Jun 17, 2019

Thanks. Since this needs a working ArcGIS license, which I don't have (on my computer), could you please also upload the resulting .markdown file in the _posts directory?

@be-marc
Copy link
Member Author

be-marc commented Jun 20, 2019

@edzer Done

@edzer
Copy link
Member

edzer commented Jul 21, 2019

Thanks. Is this ready to go live?

@be-marc
Copy link
Member Author

be-marc commented Jul 21, 2019

@edzer The .md file is missing because the makefile does not work for me. Maybe you can run it? You don't need an ArcGIS license because the code chunks are set to eval=FALSE.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants