From 6b5f27bff1a5d744982042235b596265fb143e9d Mon Sep 17 00:00:00 2001 From: pat-s Date: Tue, 17 Jan 2017 18:09:49 +0100 Subject: [PATCH] update docs/ --- docs/articles/index.html | 2 +- docs/articles/install_guide.html | 2 +- docs/index.html | 28 +++++++-------------------- docs/news/index.html | 32 ++++++++++++++++++++++--------- docs/reference/dem.html | 4 ++-- docs/reference/index.html | 2 +- docs/reference/ndvi.html | 4 ++-- docs/reference/random_points.html | 4 ++-- docs/reference/run_qgis.html | 6 +++--- 9 files changed, 42 insertions(+), 42 deletions(-) diff --git a/docs/articles/index.html b/docs/articles/index.html index 9ddcd8c..7c83237 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -75,7 +75,7 @@
-

Vignette reference version 0.1.0.9000

+

Vignette reference version 0.2.0

diff --git a/docs/articles/install_guide.html b/docs/articles/install_guide.html index 5e267a0..5da9447 100644 --- a/docs/articles/install_guide.html +++ b/docs/articles/install_guide.html @@ -60,7 +60,7 @@

(R)QGIS installation guide for Windows, Mac & Linux

Jannes Muenchow, Patrick Schratz

-

2017-01-12

+

2017-01-17

diff --git a/docs/index.html b/docs/index.html index c80c167..16378c7 100644 --- a/docs/index.html +++ b/docs/index.html @@ -5,7 +5,7 @@ -RQGIS: Integrating R with QGIS • RQGIS +Integrating R with QGIS • RQGIS @@ -117,14 +117,6 @@

# finally you can install libcurl sudo apt-get install libcurl4-gnutls-dev -
-

- QGIS >2.16 modifications

-

If you only installed QGIS version >2.16, you need to fix manually a Processing error in order to make RQGIS work. First, add one import statement (SilentProgress) to ../processing/gui/AlgorithmExecutor.py. Secondly replace python alg.execute(progress) by python alg.execute(progress or SilentProgress()):

-

-

The QGIS core team has already fixed this issue (see also this post). Hence, with the next minor release the manual adjustment is hopefully no longer required.

-

For Windows users: If you installed both the LTR and the most recent QGIS version, you don’t need to adjust anything since RQGIS will use by default the LTR (2.14).

-

@@ -206,18 +198,12 @@

Of course, this is a very simple example. We could have achieved the same using sp::coordinates. To harness the real power of integrating R with a GIS, we will present a second, more complex example. Yet to come in the form of a paper…

-
+

- TO DO:

-
    -
  • post QGIS > 2.16 issue has still not been resolved. The issue has become even worse since no error message is reported. Instead everything runs smoothly, there is even a message that the output was created. Just there is none in the specified folders. Only fixing the SilentProgress()-stuff makes the issue go away…
    • -
  • install_guide Linux compile SAGA from source is now on git (previously svn) -> change the documentation accordingly
    • -
  • batch_call function since we had to duplicate these lines several times…
    • -
  • execute_cmds: rewrite in in such a way, that you can add further python commands!!
    • -
  • open_help: automatically construct a helpfile if no documentation is availabe on the Internet (-> if Python web scraping “Error” is True, construct html file)
    • -
  • does it make sense to create a RQGIS-class?
    • -
  • qgis_session_info -> add OTB and Lidar to the list
    • -
+ (R)QGIS modifications (v. 2.16-2.18.1)

+

If you would like to use QGIS versions 2.16-2.18.1, you need to fix manually a Processing error in order to make RQGIS work. First, add one import statement (SilentProgress) to ../processing/gui/AlgorithmExecutor.py. Secondly replace python alg.execute(progress) by python alg.execute(progress or SilentProgress()):

+

+

The QGIS core team fixed this bug, and starting with QGIS 2.18.2 this manual adjustment is no longer necessary post. Hence, we would recommend strongly to either use the QGIS LTR or QGIS >= 2.18.2.

@@ -247,7 +233,7 @@

Dev status

  • Project Status: Active – The project has reached a stable, usable state and is being actively developed.
  • codecov
  • minimal R version
    • -
  • Last-changedate
    • +
  • Last-changedate
    • diff --git a/docs/news/index.html b/docs/news/index.html index ea43497..cebc631 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -82,29 +82,43 @@

    Change log All releases

    -
    +

    - RQGIS 0.1.0.9000

    + RQGIS 0.2.0 +
    +

    + General

    • -run_qgis bug fix: There was a problem when using QGIS/Grass on a MacOS. Deleting one bash statement (paste0("export PATH='", qgis_env$root, "/Contents/MacOS/bin:$PATH'"))) solved the problem.
      • -
    • RQGIS now also does testing using the testthat-package.
      • -
    • bug fix: when constructing the cmd-command (in run_qgis), we need to avoid “double” shell quotes. This happened e.g., with grass7:r.viewshed. Additionally, we made sure that None, True and False are not shellquoted.
      • -
    • bug fix: when determining the GRASS REGION PARAMETER in run_qgis. To extract the extent of a spatial object ogrInfo needs the layer name without the file extension. To do that we now use the file_path_sans_ext of the tools package instead of a simple gsub-command. Previously, we simply returned everything in front of a colon. This caused problems with filenames such as gis.osm_roads_free_1.shp.
      • +build_cmds now retrieves the working directory on the command line from where the script has been called (temporary folder), and makes it the working directory at the end of the batch script. This ensures that py_cmd.py can be found and executed (necessary since QGIS 2.18.2 since they somehow change the wd in one of their .bat-files) (#26, @eivindhammers). +
    • RQGIS now also does testing using the testthat-package (#20).
    • run_qgis stops if the user specifies one of the interactive QGIS Select-by operations.
    • run_qgis now stops if the output shapefile created by QGIS is empty.
      • -
    • Removing a bug from run_qgis. Function argument load_output now checks if the QGIS output was really created before trying to load it.
    • run_qgis-message: Use qgis:creategrid instead of qgis:vectorgrid.
      • -
    • vignette update (MacOSX and homebrew installation)
    • Fine-tuning of the documentation files
    • Deleting redundancies in functions build_cmds, check_apps and execute_cmds
    • Removing empty string from find_algorithms output
    • Added a NEWS.md file to track changes to the package.
      • +
    • vignette update (MacOSX and homebrew installation) (#14, @pat-s)
    +
    +
    +

    + Bug fixes

    +
      +
    • bug fix: we replaced findstr in set_env by the more general %SystemRoot%\\System32\\findstr +
      • +
    • bug fix: when constructing the cmd-command (in run_qgis), we need to avoid “double” shell quotes. This happened e.g., with grass7:r.viewshed. Additionally, we made sure that None, True and False are not shellquoted.
      • +
    • bug fix: when determining the GRASS REGION PARAMETER in run_qgis. To extract the extent of a spatial object ogrInfo needs the layer name without the file extension. To do that we now use the file_path_sans_ext of the tools package instead of a simple gsub-command. Previously, we simply returned everything in front of a colon. This caused problems with filenames such as gis.osm_roads_free_1.shp.
      • +
    • bug fix: run_qgis function argument load_output now checks if the QGIS output was really created before trying to load it.
      • +
    • bug fix: There was a problem when using QGIS/Grass on a MacOS. Deleting one bash statement (paste0("export PATH='", qgis_env$root, "/Contents/MacOS/bin:$PATH'"))) solved the problem.
      • +
    • bug fix: qgis_session_info now also runs on MacOS (#34)
      • +
    +
    @@ -113,7 +127,7 @@

    Contents

    diff --git a/docs/reference/dem.html b/docs/reference/dem.html index b9e6aea..505f259 100644 --- a/docs/reference/dem.html +++ b/docs/reference/dem.html @@ -81,7 +81,7 @@

    Digital elevation model (DEM) of the Mongón study area.

    -

    A raster object (EPSG:32717) representing +

    A raster object (EPSG:32717) representing altitude (ASTER GDEM, LP DAAC 2012). For more details, please refer to Muenchow et al. (2013).

    @@ -90,7 +90,7 @@

    Digital elevation model (DEM) of the Mongón study area.

    Format

    -

    A raster with 117 rows and 117 columns: +

    A raster with 117 rows and 117 columns:

    dem
    Altitude in m asl.

    diff --git a/docs/reference/index.html b/docs/reference/index.html index 36b8d71..9a0a06e 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -78,7 +78,7 @@

    Function reference

    -

    version 0.1.0.9000

    +

    version 0.2.0

    diff --git a/docs/reference/ndvi.html b/docs/reference/ndvi.html index d076773..1061f22 100644 --- a/docs/reference/ndvi.html +++ b/docs/reference/ndvi.html @@ -81,7 +81,7 @@

    Normalized difference vegetation index for the Mongón study area.

    -

    NDVI raster (EPSG:32717) computed from a +

    NDVI raster (EPSG:32717) computed from a Landsat scene (path 9, row 67, acquisition date: 09/22/2000; USGS 2013). For more details, please refer to Muenchow et al. (2013).

    @@ -90,7 +90,7 @@

    Normalized difference vegetation index for the Mongón study area.

    Format

    -

    A raster with 117 rows and 117 columns: +

    A raster with 117 rows and 117 columns:

    ndvi
    Normalized difference vegetation index.

    diff --git a/docs/reference/random_points.html b/docs/reference/random_points.html index 8febebc..f509b58 100644 --- a/docs/reference/random_points.html +++ b/docs/reference/random_points.html @@ -81,7 +81,7 @@

    Random points.

    -

    A SpatialPointsDataFrame (EPSG:32717) object +

    A SpatialPointsDataFrame (EPSG:32717) object with 100 randomly sampled points (stratified by altitude). For more details, please refer to Muenchow et al. (2013).

    @@ -90,7 +90,7 @@

    Random points.

    Format

    -

    A SpatialPointsDataFrame object with 100 rows and 4 +

    A SpatialPointsDataFrame object with 100 rows and 4 variables:

    id
    Plot ID.
    diff --git a/docs/reference/run_qgis.html b/docs/reference/run_qgis.html index 365f74a..8ca89c2 100644 --- a/docs/reference/run_qgis.html +++ b/docs/reference/run_qgis.html @@ -131,9 +131,9 @@

    Note

    Please note that one can also pass spatial R objects as input parameters where suitable (e.g., input layer, input raster). Supported formats are - SpatialPointsDataFrame-, - SpatialLinesDataFrame-, - SpatialPolygonsDataFrame- and + SpatialPointsDataFrame-, + SpatialLinesDataFrame-, + SpatialPolygonsDataFrame- and raster-objects. See the example section for more details.

    GRASS users do not have to specify manually the GRASS region extent (function