R语言 RSAGA包 rsaga.geoprocessor()函数中文帮助文档(中英文对照)

loveR

rsaga.geoprocessor(RSAGA)
rsaga.geoprocessor()所属R语言包：RSAGA

                                        Generic R interface for SAGA modules
                                         SAGA模块的通用R接口

                                         译者：生物统计家园网 机器人LoveR

描述----------Description----------

This function is the workhorse of the R–SAGA interface: It calls the SAGA command line tool to run SAGA modules and pass
此功能是主力的R-SAGA接口：它调用的SAGA命令行工具来运行SAGA模块，并通过


用法----------Usage----------


rsaga.geoprocessor(lib, module = NULL, param = list(), prefix = NULL,
        silent = FALSE, beep.off, show.output.on.console = TRUE,
        invisible = TRUE, intern = TRUE, env = rsaga.env(), display.command = FALSE,
        reduce.intern=TRUE, check.module.exists = TRUE, warn = options("warn")$warn,
        ...)



参数----------Arguments----------

参数：lib
Name of the SAGA library to be called (see Details).
被称为（见详情）的SAGA库的名称。


参数：module
Number (>=0) or name of the module to called within the library lib (see Details).
号码（>=0）或模块的名称被称为库中的lib（详细）。


参数：param
A list of named arguments to be passed to the SAGA module (see Examples).
列表命名参数传递给SAGA模块（见例）。


参数：prefix
optional character string: prefix such as "-h" used in the saga_cmd call; mostly for internal purposes; call saga_cmd -h from the command line for details
可选的字符串：前缀，如"-h"saga_cmd调用中使用，主要用于内部用途;调用“saga_cmd -h命令行的详细信息，


参数：silent
(deprecated)
（不建议使用）


参数：beep.off
is currently ignored (did never really work and produced some unwanted side effects); a warning is produced if beep.off is specified.
目前被忽略（也从来没有真正的工作，产生了一些不必要的副作用）;产生，如果beep.off指定的警告。


参数：show.output.on.console
a logical (default: TRUE), indicates whether to capture  the output of the command and show it on the R console (see system).
逻辑（默认：TRUE），指示是否捕获命令的输出，并显示它的R控制台（见system）。


参数：invisible
a logical, indicates whether the command window  should be visible on the screen.
一个逻辑，表示是否在命令窗口在屏幕上是可见的。


参数：intern
a logical, indicates whether to make the output  of the command an R object
逻辑，表示是否把命令的输出R对象


参数：env
A SAGA geoprocessing environment, i.e. currently a list with information on the SAGA and SAGA modules paths and the name of the working directory in which to look for input and output files. (Defaults: see rsaga.env.)
SAGAGEO处理环境，即目前的信息SAGA和SAGA模块路径和工作目录的名称的列表，在其中寻找输入和输出文件。 （默认值：rsaga.env）。


参数：display.command
Display the DOS command line for executing the SAGA module (including all the arguments to be passed). Default: FALSE.
显示DOS命令行中执行SAGA模块（包括所有要传递的参数）。默认值：FALSE。


参数：reduce.intern
If intern=TRUE, reduce the text output of SAGA returned to R by eliminating redundant lines showing the progress of module execution etc. (default: TRUE).
如果intern=TRUE，减少的文本输出SAGA返回到R模块执行等所取得的进展，通过消除多余的线条（默认：TRUE）。


参数：check.module.exists
logical (default: TRUE): call rsaga.module.exists to determine if the specified module can be called in the current SAGA installation
逻辑（默认：TRUE）：调用“rsaga.module.exists，以确定是否在当前SAGA安装指定的模块可以被称为


参数：warn
logical (default: TRUE): for internal purposes - can be used to suppress warning messages generated by failed SAGA_CMD calls; currently used by rsaga.get.lib.modules and related functions; see options argument warn for details   
逻辑（默认：TRUE）：内部用途 - 可以用来抑制失败的SAGA_CMD通话所产生的警告消息;目前使用rsaga.get.lib.modules和相关的功能，请参阅options参数<X >的详细信息，


参数：...
Additional arguments to be passed to system.
其他的参数被传递给system。


Details

详细信息----------Details----------

This workhorse function establishes the interface between the SAGA command line program and R by submitting a system call. This is a low-level function that may be used for directly accessing SAGA; specific functions such as rsaga.hillshade are intended to be more user-friendly interfaces to the most frequently used SAGA modules. These higher-level interfaces support default values for the arguments  and perform some error checking; they should therefore be preferred if available.
主力提交系统调用函数建立的的SAGA命令行程序和R之间的接口。这是一个低级别的功能，可用于直接访问SAGA;特定功能，如rsaga.hillshade的目的是要更加用户友好的接口，使用最频繁的SAGA模块。这些高层次的接口支持默认的参数值，并执行一些错误检查，如果有，因此，他们应该是首选。

A warning is issued if the RSAGA version is not one of 2.0.4, 2.0.5, 2.0.6 or 2.0.7.
RSAGA版本是2.0.4，2.0.5，2.0.6或2.0.7，将发出警告。


值----------Value----------

The type of object returned depends on the intern argument passed to system.
返回的对象的类型取决于intern参数传递给system。

If intern=FALSE, a numerical error/success code is returned, where a value of 0 corresponds to success and a non-zero value indicates an error. Note however that the function always returns a success value of 0 if wait=FALSE, i.e. if it does not wait for SAGA to finish.
如果intern=FALSE，一个数字的错误/成功返回代码，其中的值0对应的成功和一个非零值表示错误。但是请注意，该函数总是返回成功的价值0如果wait=FALSE，即如果它不等待SAGA完成。

If intern=TRUE (default), the console output of SAGA is returned as a character vector. This character vector lists the input file names and modules arguments, and gives a more or less detailed report of the function's progress. Redundant information can be cancelled out by setting reduce.intern=TRUE.
如果intern=TRUE（默认），SAGA的控制台输出返回的字符向量。这个人物矢量列出了输入文件名和模块参数，并报告给出了或多或少详细的函数的进步。冗余信息可以被取消，满分通过设置reduce.intern=TRUE。


注意----------Note----------

Existing output files will be overwritten by SAGA without prompting!
不提示的情况下，现有的输出文件将被覆盖由SAGA！

If a terrain analysis function is not directly interfaced by one of the RSAGA functions, you might still find it in the growing set of SAGA libraries and modules. The names of all libraries available in your SAGA installation can be obtained using rsaga.get.libraries (or by checking the directory listing of the modules folder in the SAGA directory). The names and numeric codes of all available modules (globally or within a specific library) are retreived by rsaga.get.modules. Full-text search in library and module names is performed by  rsaga.search.modules. For information on the usage of SAGA command line modules, see rsaga.get.usage, or the RSAGA interface function if available.
RSAGA功能之一，如果地形分析功能，不直接连接，你可能仍然觉得它在日益增长的SAGA库和模块。 SAGA安装在你的所有的图书馆的名称，可以使用rsaga.get.libraries（或通过检查modules的文件夹的SAGA目录）的目录列表。 retreived的rsaga.get.modules的所有可用的模块（或在一个特定的库）的名称和数字代码。全文搜索在图书馆和模块名称是由rsaga.search.modules。使用的SAGA命令行模块的信息，请参阅rsaga.get.usage，或RSAGA接口功能，如果有的话。

display.command=TRUE is mainly intended for debugging purposes
display.command=TRUE主要用于调试目的


（作者）----------Author(s)----------


Alexander Brenning (R interface); Olaf Conrad and the
SAGA development team (SAGA development)



参见----------See Also----------

rsaga.env, rsaga.get.libraries, rsaga.get.modules, rsaga.search.modules, rsaga.get.usage; rsaga.esri.wrapper for a wrapper for ESRI ASCII/binary grids;
rsaga.env，rsaga.get.libraries，rsaga.get.modules，rsaga.search.modules，rsaga.get.usagersaga.esri.wrapper的包装ESRI ASCII /二进制电网的;


实例----------Examples----------


## Not run: [＃不运行：]
rsaga.hillshade("dem","hillshade",exaggeration=2)
# using the RSAGA geoprocessor:[使用的RSAGA geoprocessor：]
rsaga.geoprocessor("ta_lighting",0,list(ELEVATION="dem.sgrd",SHADE="hillshade",EXAGGERATION=2))
# equivalent DOS command line call:[相当于DOS命令行调用：]
# saga_cmd.exe ta_lighting 0 -silent -ELEVATION dem.sgrd -SHADE hillshade -EXAGGERATION 2 [saga_cmd.exe ta_lighting 0无声海拔dem.sgrd荫山体阴影夸张2]

## End(Not run)[＃（不执行）]

转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。


注：
注1：为了方便大家学习，本文档为生物统计家园网机器人LoveR翻译而成，仅供个人R语言学习参考使用，生物统计家园保留版权。
注2：由于是机器人自动翻译，难免有不准确之处，使用时仔细对照中、英文内容进行反复理解，可以帮助R语言的学习。
注3：如遇到不准确之处，请在本贴的后面进行回帖，我们会逐渐进行修订。