R语言 RNetLogo包 NLGetPatches()函数中文帮助文档(中英文对照)

loveR

NLGetPatches(RNetLogo)
NLGetPatches()所属R语言包：RNetLogo

                                         Reports the values of the variables of the patches as a data.frame (optional as a list, matrix or simple vector)
                                         报告数据框（可选的补丁的变量的值的列表，矩阵或简单的向量）

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

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

NLGetPatches is an easy-to-use way to access variables of all patches (default) or of  an subset of patches.
NLGetPatches是一个易于使用的方式访问变量的所有补丁（默认）或修补程序的一个子集。


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


NLGetPatches(patch.var, patchset="patches", as.matrix=FALSE,
             as.data.frame=TRUE, patches.by.row=FALSE,
             as.vector=FALSE, nl.obj=NULL)



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

参数：patch.var
A string or vector/list of strings with the names of patch-variables to be reported.  
一个字符串或向量/字符串列表与补丁变量的名称予以报道。


参数：patchset
(optional) A string defining which patches should be requested.  By default, values of all patches will be returned.  
（可选）一个字符串，定义了哪些修补程序应要求。默认情况下，所有修补程序的值将被退回。


参数：as.matrix
(optional) If this variable is TRUE (default is FALSE), the function will return the result as a matrix representing the NetLogo world. (Only available if you don't change the argument patchset, i.e. if you request the all patches/the whole world and you request only one patch variable,  i.e. length of patch.var is 1.)  
（可选）如果这个变量是TRUE（默认是FALSE），该函数将返回的结果是一个矩阵代表的NetLogo世界。 （仅适用，如果你不改变参数patchset，也就是说，如果你要求所有的补丁/整个世界，您的要求只有一个修补程序变量，即patch.var的长度为1。）


参数：as.data.frame
(optional) If TRUE (default) the function returns a data.frame with a column for each patch.var and a row for each patch.  The column names are taken from the names of the patch.var argument.  If FALSE the function will return a list instead of a data.frame  (a little bit faster, when not using patches.by.row=TRUE) .     
（可选）如果TRUE（默认），函数返回一个数据框，为每个补丁每个patch.var和一排一列。列名patch.var参数的名字。如果FALSE的功能将返回一个列表，而不是一个数据框（快一点点，不使用时patches.by.row=TRUE）。


参数：patches.by.row
(optional) Has an effect only in combination with as.data.frame=FALSE, i.e. a list should be returned.   If patches.by.row=FALSE (default) the returned list contains one list element for each patch.var. Each list element contain a vector with the values of the different patches (patchset). If patches.by.row=TRUE the returned list contains one list element for each patch. Each list element contain a vector with the values of the different request patch variables (patch.var). Attention: patches.by.row=TRUE makes the function very slow, especially when many patches are requested.   
（可选）的效果，只有在搭配as.data.frame=FALSE，即应该返回的列表。如果patches.by.row=FALSE（默认）返回的列表中包含一个列表中为每个patch.var元素。每个列表元素包含一个矢量的值在不同的补丁（patchset）。如果patches.by.row=TRUE返回的列表包含一个列表中的元素为每个补丁。每个列表元素包含一个矢量的值不同的要求修补程序变量（patch.var）。注意：patches.by.row=TRUE功能很慢，特别是当许多的修补程序要求。


参数：as.vector
(optional) If you request only one patch variable you can ask for getting the result as a simple vector by setting this argument to TRUE. This is the fastest way to access one patch variable. It does not make sense to set this variable to TRUE together with as.data.frame=TRUE or as.matrix=TRUE, but as.vector is processed first and will win the race if you accidently set as.data.frame or as.matrix to TRUE as well.  By default as.vector is FALSE.   
（可选）如果你只要求一个修补程序变量，你可以要求得到的结果作为一个简单的矢量将此参数设置为TRUE。这是最快的方式来访问一个修补程序变量。不设置这个变量TRUE一起as.data.frame=TRUE或as.matrix=TRUE，但as.vector是先处理，并会赢得比赛，如果你不小心将<X >或as.data.frame到as.matrix。默认情况下TRUE是as.vector。


参数：nl.obj
(optional) A variable holding a reference to a NetLogo instance created with NLStart.  
（可选）变量参考到的NetLogo实例的创建与NLStart。


Details

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

It's possible to use all the variables of a patch, which can be found in the inspect window. See the document performanceNotes.pdf in directory performanceNote in the installation directory of the package for performance details.
它可以使用一个补丁，可以发现在检查窗口中的所有变量。请参阅文档performanceNotes.pdf目录中的performanceNote的安装目录中的包的性能的详细信息。


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

Returns a data.frame (optional a list) with the value(s) of the patch/patchset variable(s).  One row for each patch and one column for each patch variable. The result is sorted (like using sort patchset in NetLogo, e.g. patches are sorted from upper left to lower right.
返回一个数据框（可选的列表）的值（S）的修补程序/补丁变量（S）。一个行每个补丁变量的每个补丁和一列。结果排序（一样使用sort patchset的NetLogo，例如补丁进行排序，从左上角到右下角。

To get the same result as with default settings until RNetLogo version 0.9.2 use: as.data.frame=FALSE and patches.by.row=TRUE.
为了得到相同的结果，使用默认设置，直到RNetLogo版本0.9.2使用方法：as.data.frame=FALSE和patches.by.row=TRUE。


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



Jan C. Thiele &lt;jthiele@gwdg.de&gt;




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

NLReport, NLGetAgentSet, NLGetGraph
NLReport，NLGetAgentSet，NLGetGraph


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


## Not run: [＃不运行：]
NLStart("C:/Program Files/NetLogo 5.0")
# NLLoadModel(...)[NLLoadModel（...）]

allpatches <- NLGetPatches(c("pxcor","pycor","pcolor"))
str(allpatches)

# only a subset of all patches[只有一小部分的所有补丁]
subsetpatches <- NLGetPatches(c("pxcor","pycor","pcolor"),
                              "patches with [pxcor < 5]")
str(subsetpatches)

# or as a list (slightly faster):[或作为一个列表（稍微快一些）：]
colors.list <- NLGetPatches(c("pxcor","pycor","pcolor"),
                        "patches with [pxcor < 5]", as.data.frame=FALSE)
str(colors.list)

# or as a list with one list element for each patch[或作为一个列表中的元素的列表，每个补丁]
# (very slow!, not recommended especially for large patchsets)[（很慢，不建议使用，尤其是对大补丁集）]
colors.list2 <- NLGetPatches(c("pxcor","pycor","pcolor"),
                        "patches with [pxcor < 5]", as.data.frame=FALSE,
                        patches.by.row=TRUE)
str(colors.list2)

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

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


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