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

loveR

templateDescriptionFile(cellHTS2)
templateDescriptionFile()所属R语言包：cellHTS2

                                        Creates a template description file for an RNAi experiment
                                         创建一个RNAi实验的模板说明文件

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

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

This function creates a template description file for an RNAi experiment with default entries compliant with MIAME class  and with additional entries specific for a cellHTS object.
这个函数创建一个RNAi实验模板默认条目符合MIAME类的和额外的条目与cellHTS对象的具体描述文件。


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


  templateDescriptionFile(filename="Description.txt", path, force=FALSE)



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

参数：filename
the name of the output file. Default is "Description.txt".
输出文件的名称。默认是Description.txt“。


参数：path
a character of length 1 indicating the path in which to create the screen description file.  By default, it can extract the path from filename.
一个字符的长度为1表示要在其中创建屏幕描述文件的路径。默认情况下，它可以从filename提取的路径。


参数：force
a logical value, determines the behaviour of the function if file filename exists. If force is TRUE, the function overwrites filename, otherwise it casts an error.
一个逻辑值，决定了行为的功能，如果文件filename存在。 force如果是TRUE，功能覆盖filename，否则施放的错误。


Details

详情----------Details----------

This function can be called to generate a template file for the RNAi experiment.  This file contains the fields that are compliant with the MIAME class and also additional entries specific for the  cellHTS class, which should be edited and completed by the user.
这个函数可以调用生成的RNAi实验的模板文件。此文件包含的领域，是符合MIAME类cellHTS类，它应该由用户进行编辑和完成特定的附加条目。

This file, which we call Screen description file, is required to configure the cellHTS object via function configure. It is intended to contain general information about the screen, such as its title, its goal, when and how it was performed, which organism, which library, type of assay, references, and any other information that is pertinent to the biological interpretation of the experiments.
这个文件，我们称之为屏幕描述文件，需要通过函数cellHTS配置configure对象。它的目的是包含屏幕的一般信息，如它的标题，它的目标，何时以及如何进行，它的有机体，哪个库，检测类型，引用，和任何其他信息，是有关生物解释，实验。


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

The function returns a character with the full path and name of the file that was created.
该函数返回所创建的文件的完整路径和名称的字符。


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


Ligia Bras <a href="mailto:ligia@ebi.ac.uk">ligia@ebi.ac.uk</a>



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

configure
configure


举例----------Examples----------


  out <- templateDescriptionFile("Description.txt", path=tempdir())
  out
  readLines(out)

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


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