R语言ZooImage使用的各种实用程序功能zipNoteAdd()函数-中英文对照帮助文档

MicroRbt

        R语言ZooImage使用的各种实用程序功能zipNoteAdd()函数-中英文对照帮助文档

                                         By MicroRbt Martinez PhD

R语言函数名：zipNoteAdd()
R语言函数功能：ZooImage使用的各种实用程序功能
来自资源库：CRAN
zipNoteAdd()函数所属R语言包：所在R包具体名称、包功能的中英文双语描述见正文后面'--所在R语言包信息--'部分。

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

These functions are usually not called directly by the user, but they are interesting for developers.
这些函数通常不由用户直接调用，但是对于开发人员来说很有趣。


使用方法-----Usage-----

sampleInfo(filename, type = c("sample", "fraction", "image", "scs",
"date", "id", "frac", "imgnbr"), ext = "_dat[135][.]zim$")
underscoreToSpace(string)
trimString(string)
listSamples(ZIobj)
makeId(ZIDat)
addClass(ZIDat, ZIobj)
calcVars(x, drop.vars = NULL, drop.vars.def = dropVars())
dropVars()
ecd(area, cells = 1)
parseIni(data, label = "1")
calibrate(ODfile)
getDec()
zipNoteAdd(zipfile, zimfile)
zipNoteGet(zipfile, zimfile = NULL)
makeZIVignettes(orig.dir = getwd(), target.dir = dirname(orig.dir), clean.work = FALSE)

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

参数filename介绍: name of a file from which to extract information. It is supposed to be spelled as: SCS.xxxx-xx-xx.SS+Fnn.ext where 'SCS' is the series-cruise-station code, 'xxxx-xx-xx' is the date of collection (year-month-day), 'SS' is the unique sample identifier, 'F' is the fraction, 'nn' is the image number (when there are several images per fraction) or 'nn.mmm' when there are 'mmm' pictures taken to cover a bigger area of cell 'nn', and 'ext' is the file extension.
从中提取信息的文件的名称。应该将其拼写为：SCS.xxxx-xx-xx.SS + Fnn.ext，其中“ SCS”是系列巡游站代码，“ xxxx-xx-xx”是收款日期（年月） -day），“ SS”是唯一的样本标识符，“ F”是分数，“ nn”是图像编号（当每个分数有多个图像时），或者在“ mmm”照片拍摄时为“ nn.mmm”可以覆盖单元格“ nn”的更大区域，而“ ext”是文件扩展名。

参数type介绍: the type of data to extract (see examples) for sampleInfo(), or the type of file to select in selectFile().
sampleInfo()要提取的数据类型（请参见示例），或在selectFile()中选择的文件类型。

参数ext介绍: the pattern to use (regular expression) to eliminate file extension from the 'filename'.
用于从“文件名”中消除文件扩展名的模式（正则表达式）。

参数string介绍: a character string to rework, or a vector of character strings.
要重做的字符串或字符串向量。

参数ZIobj介绍: a ZooImage object (here, a 'ZIDat', 'ZIDesc', 'ZITrain' or 'ZITest' object; most probably one of the last two for addClass()).
ZooImage对象（此处为“ ZIDat”，“ ZIDesc”，“ ZITrain”或“ ZITest”对象；最有可能是addClass()的后两个对象之一）。

参数ZIDat介绍: a 'ZIDat' object, or a data frame with correct column labels.
“ ZIDat”对象或带有正确列标签的数据框。

参数x介绍: a data frame, but most probably, a 'ZIDat' object.
数据帧，但最有可能是“ ZIDat”对象。

参数drop.vars介绍: a character vector with names of variables to drop, or NULL (by default) to keep them all.
具有要删除的变量名称的字符向量，或NULL（默认情况下）以保留所有变量。

参数drop.vars.def介绍: a second list of variables to drop contained in a character vector. That list is supposed to match the name of variables that are obviously non informative and that are dropped by default. It can be gathered automatically using dropVars(). That list includes Id, Label, Dil, ... (see details, variables with an asterisk).
包含在字符向量中的第二个变量列表。该列表应该与显然无用的变量名匹配，并且默认情况下将其删除。可以使用dropVars()自动收集它。该列表包括Id，Label，Dil等（请参阅详细信息，带星号的变量）。

参数area介绍: a numerical vector with areas from which ECDs are calculated (Equivalent Circular Diameter, a more suitable term for 2D images than ESD, Equivalent Spherical Diameter).
一个带有计算出ECD的区域的数值矢量（等效圆直径，比ESD更适合用于2D图像的项，等效球直径）。

参数cells介绍: the number of cells in the particle (colony). If different from 1, the area is first divided by the number of cells bevore calculating the cell individual ECD.
粒子中的细胞数（菌落）。如果不等于1，则首先将面积除以单元数，然后再计算单元个体ECD。

参数data介绍: a vector containing the data to parse.
包含要解析的数据的向量。

参数label介绍: a label to include for the parsed data.
要包含在已解析数据中的标签。

参数ODfile介绍: an image file of O.D. calibrated items that can be used to calibrate grayscales.
外径的图像文件可用于校准灰度的校准项目。

参数zipfile介绍: a zip archive.
zip存档。

参数zimfile介绍: a .zim file to use, or to create. If NULL (default) in zipNoteGet(), the data are not written in a file, but returned.
.zim文件以使用或创建。如果zipNoteGet()中的NULL（默认值），则数据未写入文件中，而是返回了。

参数orig.dir介绍: the directory containing the data (current directory by default)
包含数据的目录（默认为当前目录）

参数target.dir介绍: where to place the results, by defaut, the parent directory of orig.dir
defaut在哪里将结果放置在orig.dir的父目录中

参数clean.work介绍: should we clean intermediary items (FALSE, by default)
我们是否应该清理中间项目（默认情况下，FALSE）


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

As these functions are not made to be directly used by end-users, We don't give more details here. Developers interested to use these functions are encouraged to look at their code in the zooimage package source!
由于这些功能不能让最终用户直接使用，因此我们在此不提供更多详细信息。鼓励有兴趣使用这些功能的开发人员在zooimage软件包源代码中查看他们的代码！

Here is the list of all variables you got after running the standard version of calcVars() on ZIDat objects made by one of the ZooImage ImageJ plugins (you can provide your own version for, e.g., calculating more features):
这是在由ZooImage ImageJ插件之一制作的ZIDat对象上运行标准版本的calcVars()之后获得的所有变量的列表（您可以提供自己的版本，例如用于计算更多功能）：

Variable: Description <td style="text-align: left;"> Origin </td>
Variable:说明<td style =“ text-align：left;”>来源</ t

-----未完，待续-----，↓↓↓展开剩余72%↓↓↓