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

loveR

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

                                         Creates an instance of NetLogo
                                         创建一个实例的NetLogo

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

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

NLStart can be used to create a new instance of NetLogo in headless (without the Graphical User Interface) or GUI mode.
NLStart可以用来创建一个新的实例的NetLogo无头（不带图形用户界面）或GUI模式。


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


NLStart(nl.path, gui=TRUE, obj.name=NULL, nl.version=5, is3d=FALSE)



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

参数：nl.path
Path to your NetLogo installation (the folder where the NetLogo.jar is).  
路径您的NetLogo安装（文件夹中的NetLogo.jar）。


参数：gui
(optional) A boolean value: if TRUE, NetLogo will be started with GUI (only one instance with GUI can be created currently!).  FALSE will start NetLogo in headless mode.  
（可选）一个布尔值：TRUE如果的NetLogo将开始与图形用户界面（GUI可以只有一个实例被创建目前！）。 FALSE将开始在headless模式下的NetLogo。


参数：obj.name
(optional) A string with the name of the variable which should be created and will contain the reference to the NetLogo instance.  After the execution of NLStart is finished, there will be a variable with the given name in the  global scope. This variable is needed for all further transactions and is always the last argument of the other functions of the RNetLogo package. If you don't specify this variable, an intern (in .rnetlogo environment) variable will be created and automaticaly used in all further functions.  
（可选）一个字符串，应建立以NetLogo实例将包含参考的变量的名称。后的执行NLStart的完成后，会有一个变量，在全球范围内给定的名称。此变量所需的所有进一步的交易，永远是最后一个参数的其他功能的RNetLogo包。如果你不指定这个变量，的实习生。rnetlogo环境变量将被创建和automaticaly使用更多的功能。


参数：nl.version
(optional) An interger value, that determines, if you want to start a NetLogo version 4.0.x, 4.1.x or a NetLogo version 5.x. Don't try to start a NetLogo version 4.x with nl.version=5 and vice versa. It is not possible to mix NetLogo versions in one R session. Please use different R sessions if you want to start RNetLogo with version 4 and version 5. The default is nl.version=5 for NetLogo 5.0. For NetLogo 4.1.x use nl.version=4. For NetLogo 4.0.x use nl.version=40. Please note, that the data transformation is much faster in NetLogo 5.0 than in NetLogo 4.x. Therefore, I strongly recommend to use NetLogo 5.0. See the document performanceNotes.pdf in directory performanceNote in the installation directory of the package for performance details.  
（可选）一个整数的值，它决定，如果你想开始一个的NetLogo版本4.0.x，4.1.x或一个的NetLogo版本5.x不要试图启动的NetLogo版本4.x与nl.version = 5，反之亦然。在一个R会话，这是不可能的，混合的NetLogo版本。如果你想开始RNetLogo第4版和第5版，请使用不同的R会话。默认值是nl.version=5的NetLogo 5.0。对于使用的NetLogo 4.1.x版nl.version=4。对于使用的NetLogo 4.0.x的nl.version=40。请注意，上述数据变换是快得多的NetLogo 5.0比的NetLogo 4.x中因此，我强烈建议使用的NetLogo 5.0。请参阅文档performanceNotes.pdf目录中的performanceNote的安装目录中的包的性能的详细信息。


参数：is3d
(optional) A boolean value: if TRUE, NetLogo 3D will be started. FALSE will start the conventionally 2D NetLogo.  
（可选）一个布尔值：如果TRUE“的NetLogo 3D将开始。 FALSE将启动传统2D的NetLogo。


Details

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

You can start multiple instances of NetLogo in headless mode and save each in another variable but it is not possible to start multiple instances in GUI mode.  (It would result in an crash of R since there is no way to detach the Java Virtual Machine via rJava.)
在headless模式下，您可以从多个实例的NetLogo，并保存在另一个变量，但它不是在GUI模式下可以启动多个实例。 （它会导致崩溃的R有没有办法通过rJava分离的Java虚拟机）。

Note for Linux and Mac OS X (Mac is untested) users: If you want to use the GUI mode, then it can be necessary to run RNetLogo  in JGR application (see package JGR, http://cran.r-project.org/web/packages/JGR/index.html).
注意：对于Linux和Mac OS X（苹果是未经测试）用户：如果你想使用GUI模式，那么它可以运行RNetLogo在JGR应用（见包装JGR，http://cran.r-project.org /网络/包/ JGR / index.html）上。

General Notes:  1. You should avoid to manually change the working directory of R, because NetLogo need to have the working directory pointed to its installation path. As  the R working directory and the Java working directory depend on each other, changing the R working directory can result in unexpected behavior of NetLogo. There, you should use absolute paths for I/O processes in R instead of submitting setwd(...). Note, that the RNetLogo package changes the working directory  automatically when loading NetLogo and changes back to the former working directory when submitting NLQuit (doesn't work currently with custom obj.name). 2. It is currently not possible to quit NetLogo completly (because NetLogo quits itself via System.exit but executing System.exit will terminate the whole JVM which will terminate also rJava and finally R.). It can happen that some memory is not released although you have executed NLQuit. Therefore, it is a good idea to start a new R session whenever it is possible (e.g. if you are going to load a new model).  
一般注意事项：1。您应该避免手动更改工作目录中的R，，因为的NetLogo需要的工作指向的目录中的安装路径。由于R的工作目录和Java工作目录中互相依赖，改变R的工作目录可能会导致意外的行为的NetLogo。在那里，你应该使用绝对路径I / O进程，在R而不是提交setwd（...）。请注意，在RNetLogo包的工作目录改变时，会自动加载的NetLogo变回原工作目录时提交NLQuit（不工作目前使用自定义的obj.name）。 2。现在的时间是不可能的NetLogo完全地退出（因为的NetLogo退出本身通过的System.exit但执行System.exit将终止整个JVM也将终止rJava和R.）。它可以发生，一些不会释放内存，虽然你已执行NLQuit的。因此，这是一个好主意，开始一个新的的R会话时，它是可能的（例如，如果你要加载一个新的模型）。


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

The function implicit returns an Java Object containing the reference to the Java controlling interface stored in a variable with the name given in 3rd function argument.  This variable is needed for further transactions (like NLLoadModel or NLCommand).
隐函数返回一个Java对象，其中包含的Java控制接口在第3个函数参数的名称存储在一个变量的引用。此变量需要更多的交易（NLLoadModel或NLCommand）。


警告----------Warning ----------

It's not possible to run multiple instances of NetLogo in GUI mode! Closing NetLogo from the  NetLogo Window is blocked, because it would quit the whole R process. To close the NetLogo call NLQuit. If you use the headless mode you should first load a model with NLLoadModel  before executing other commands and reporters.
这是不可能的，在GUI模式下运行多个实例的NetLogo！以NetLogo窗口关闭的NetLogo被封锁，因为它会退出整个R进程。要关闭的NetLogo调用“NLQuit。如果您使用的headless模式下，你应该先装入一个模型NLLoadModel，然后再执行其他命令和记者。


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



Jan C. Thiele <jthiele@gwdg.de>




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

NLQuit
NLQuit


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


## Not run: [＃不运行：]
library(RNetLogo)
nl.path <- "C:/Program Files/NetLogo 5.0"
NLStart(nl.path)
NLCommand("create-turtles 10")
noturtles <- NLReport("count turtles")
print(noturtles)

# create a second NetLogo instance in headless mode (= without GUI) [创建第二个的NetLogo在headless模式下（没有GUI实例）]
# with explicit name of stored object[存储对象有明确的名称]
NLStart(nl.path, FALSE, "nlheadless1")
model.path <- "/models/Sample Models/Earth Science/Fire.nlogo"
NLLoadModel(paste(nl.path,model.path,sep=""), nlheadless1)
NLCommand("setup", nl.obj=nlheadless1)
burned1 <- NLDoReport(20, "go", c("ticks","burned-trees"),
                      as.data.frame=TRUE,df.col.names=c("tick","burned"),
                      nl.obj=nlheadless1)
print(burned1)

# create a third NetLogo instance in headless mode (= without GUI) [创建三分之一的NetLogo例如在headless模式下（没有GUI）]
# with explicit name of stored object[存储对象有明确的名称]
NLStart(nl.path, FALSE, "nlheadless2")
model.path <- "/models/Sample Models/Earth Science/Fire.nlogo"
NLLoadModel(paste(nl.path,model.path,sep=""), nlheadless2)
NLCommand("setup", nl.obj=nlheadless2)
burned2 <- NLDoReport(10, "go", c("ticks","burned-trees"),
                      as_dataframe=TRUE,dfcolnames=c("tick","burned"),
                      nl.obj=nlheadless2)
print(burned2)               

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

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


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