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

loveR

bubblePlot(SGP)
bubblePlot()所属R语言包：SGP

                                        Core bubblePlot function for SGP
                                         的核心bubblePlot功能为SGP

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

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

Function to create bubble plots associated with student growth percentile results. The function is adaptable to many representation but  is used in conjunction with results derived from summarizeSGP to represent summary level results of growth against achievement  (usually, median student growth percentile against percentage at/above proficient). The function has MANY options and users are advised to  read this documentation thoroughly as well as investigate the source code for the function itself to see what the many different representations  that are possible. The function has the ability to produce interactive data tips using the pdf2 package available on R-Forge. This package is NOT installed as part of the SGP package and must be installed separately from the package to take advantage of this functionality of the bubblePlot function. To install pdf2 from the R prompt type: install.packages("pdf2",repos="http://R-Forge.R-project.org")
函数来创建气泡图与学生的成长百分结果。该功能适用于多表示，但使用与结果来自summarizeSGP代表总结水平的成果，对成绩的增长（通常情况下，学生的成长中位数百分反对比例在/上面精通）。功能有许多选项，用户应仔细阅读本文档以及调查的源代码本身的功能看许多不同的表示是可能的。该函数的能力，产生交互式的数据提示使用pdf2包的R-Forge的。这个包不是安装的SGP包的一部分，必须分开安装的软件包才能利用此功能bubblePlot功能。安装pdf2R提示符下，键入：install.packages("pdf2",repos="http://R-Forge.R-project.org")


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


bubblePlot(
        bubble_plot_data.X,
        bubble_plot_data.Y,
        bubble_plot_data.SUBSET=NULL,
        bubble_plot_data.INDICATE=NULL,
        bubble_plot_data.BUBBLE_CENTER_LABEL=NULL,
        bubble_plot_data.SIZE,
        bubble_plot_data.LEVELS=NULL,
        bubble_plot_data.BUBBLE_TIPS_LINES,
        bubble_plot_labels.X=c("Growth", "Median Student Growth Percentile"),
        bubble_plot_labels.Y=c("Achievement", "Percent at/above Proficient"),
        bubble_plot_labels.SIZE=c(50, 100, 500, 1000),
        bubble_plot_labels.LEVELS=NULL,
        bubble_plot_labels.BUBBLE_TIPS_LINES=list("Median SGP (Count)",
                "Percent at/above Proficient"),
        bubble_plot_labels.BUBBLE_TITLES,
        bubble_plot_titles.MAIN="Growth and Achievement",
        bubble_plot_titles.SUB1="State School Performance",
        bubble_plot_titles.SUB2="Growth & Current Achievement",
        bubble_plot_titles.LEGEND1="School Size",
        bubble_plot_titles.LEGEND2_P1=NULL,
        bubble_plot_titles.LEGEND2_P2=NULL,
        bubble_plot_configs.BUBBLE_MIN_MAX=c(0.03, 0.03),
        bubble_plot_configs.BUBBLE_X_TICKS=seq(0,100,10),
        bubble_plot_configs.BUBBLE_X_TICKS_SIZE=c(rep(0.6, 5), 1, rep(0.6, 5)),
        bubble_plot_configs.BUBBLE_X_BANDS=NULL,
        bubble_plot_configs.BUBBLE_X_BAND_LABELS=NULL,
        bubble_plot_configs.BUBBLE_Y_TICKS=seq(0,100,10),
        bubble_plot_configs.BUBBLE_Y_TICKS_SIZE=rep(0.6, 11),
        bubble_plot_configs.BUBBLE_Y_BANDS=NULL,
        bubble_plot_configs.BUBBLE_Y_BAND_LABELS=NULL,
        bubble_plot_configs.BUBBLE_SUBSET_INCREASE=0,
        bubble_plot_configs.BUBBLE_SUBSET_ALPHA=list(Transparent=0.3, Opaque=0.95),
        bubble_plot_configs.BUBBLE_COLOR="deeppink2",
        bubble_plot_configs.BUBBLE_COLOR_GRADIENT_REVERSE=FALSE,
        bubble_plot_configs.BUBBLE_TIPS=TRUE,
        bubble_plot_configs.BUBBLE_PLOT_DEVICE="PDF",
        bubble_plot_configs.BUBBLE_PLOT_FORMAT="print",
        bubble_plot_configs.BUBBLE_PLOT_LEGEND=FALSE,
        bubble_plot_configs.BUBBLE_PLOT_TITLE=TRUE,
        bubble_plot_configs.BUBBLE_PLOT_BACKGROUND_LABELS=c("Growth", "Achievement"),
        bubble_plot_configs.BUBBLE_PLOT_EXTRAS=NULL,
        bubble_plot_configs.BUBBLE_PLOT_DIMENSION=NULL, ## List of WIDTH and HEIGHT
        bubble_plot_configs.BUBBLE_PLOT_NAME="bubblePlot.pdf",
        bubble_plot_configs.BUBBLE_PLOT_PATH=paste("Figures", sep=""),
        bubble_plot_pdftk.CREATE_CATALOG=FALSE)



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

参数：bubble_plot_data.X
A vector of X coordinates for the bubbles to be plotted.  
一个向量的X坐标绘制的气泡。


参数：bubble_plot_data.Y
A vector of Y coordinates for the bubbles to be plotted.  
一个向量的Y坐标绘制的气泡。


参数：bubble_plot_data.SUBSET
A boolean vector indicating a subset of the bubbles to be highlighted and plotted. When BUBBLE_TIPS are indicated, only subsetted bubbles will show bubble tips. To further accentuate highlight bubbles, their radius can be altered using the bubble_plot_configs.BUBBLE_SUBSET_INCREASE argument.  Default value is bubble_plot_data.SUBSET=NULL.  
甲布尔矢量指示的一个子集的气泡被高亮显示并绘制。表示BUBBLE_TIPS时，只有子集的气泡会显示气泡提示。为了进一步突出亮点气泡，其半径，可以改变使用bubble_plot_configs.BUBBLE_SUBSET_INCREASE参数。默认值为bubble_plot_data.SUBSET=NULL。


参数：bubble_plot_data.INDICATE
A boolean vector indicating whether to attached a label to to further highlight in a manner suitable for printing. Usually done for few bubbles. Default value is bubble_plot_data.INDICATE=NULL.  
一个布尔向量表示是否上贴了一个标签适用于印刷的方式进一步突出。一般做了几个气泡。默认值为bubble_plot_data.INDICATE=NULL。


参数：bubble_plot_data.BUBBLE_CENTER_LABEL
A character vector to label the interior of the bubbles with. Usually a vector of singleton characters.  Default value is bubble_plot_data.BUBBLE_CENTER_LABEL=NULL.  
一种字符矢量标记的内部的气泡。通常，矢量的单身字符。默认值为bubble_plot_data.BUBBLE_CENTER_LABEL=NULL。


参数：bubble_plot_data.SIZE
A vector indicating the size of each of the bubbles plotted.  
一种向量，表示每个气泡的大小绘制。


参数：bubble_plot_data.LEVELS
A vector (usually a factor) indicating categories to which the bubbles belong. Default value is bubble_plot_data.LEVELS=NULL.  
类别的气泡属于一个向量（通常是一个因素）。默认值为bubble_plot_data.LEVELS=NULL。


参数：bubble_plot_data.BUBBLE_TIPS_LINES
A list of arbitrary length indicating the different values supplied when bubble tips are requested.  Default value is bubble_plot_data.BUBBLE_TIPS_LINES=list(paste(MEDIAN_SGP, ' (', MEDIAN_SGP_COUNT, ')', sep=''), round(PERCENT_AT_ABOVE_PROFICIENT)).  
任意长度的列表显示不同的值时，气泡提示，请。默认值为bubble_plot_data.BUBBLE_TIPS_LINES=list(paste(MEDIAN_SGP, ' (', MEDIAN_SGP_COUNT, ')', sep=''), round(PERCENT_AT_ABOVE_PROFICIENT))。


参数：bubble_plot_labels.X
A vector of length 2 where the 1st component is, usually a one word summary for the axis (e.g., Growth) and the 2nd component of the vector is a label for the axis (e.g., Median Student Growth Percentile).  Default value is bubble_plot_labels.X=c('Growth', 'Median Student Growth Percentile').  
一个向量长度为2的第一个部件，通常是一个字概括的轴（如生长）和向量的第二个组成部分是为坐标轴的标签（例如，学生成长百分位数）。默认值为bubble_plot_labels.X=c('Growth', 'Median Student Growth Percentile')。


参数：bubble_plot_labels.Y
A vector of length 2 where the 1st component is, usually a one word summary for the axis (e.g., Achievement) and the 2nd component of the vector is a label for the axis (e.g., Percent at/above Proficient).  Default value is bubble_plot_labels.Y=c('Achievement', 'Percent at/above Proficient').  
一个向量长度为2的第一个部件，通常一个字概括的轴（例如，成就）和向量的第二个组成部分是一个标签的轴（例如，百分比在/上面精通）。默认值为bubble_plot_labels.Y=c('Achievement', 'Percent at/above Proficient')。


参数：bubble_plot_labels.SIZE
A vector of quantities giving breaking points for the size bubbles indicated in the legend of the plot.  Default value is bubble_plot_labels.SIZE=c(50, 100, 500, 1000).  
一个向量的数量突破点的大小气泡在传说中的图。默认值为bubble_plot_labels.SIZE=c(50, 100, 500, 1000)。


参数：bubble_plot_labels.LEVELS
A vector of quantities giving level labels associated with bubble_plot_data.LEVELS. These labels will appear in the right legend of the plot.  Default value is bubble_plot_labels.LEVELS=NULL.  
一个向量数量，级别标签与bubble_plot_data.LEVELS。这些标签将出现在正确的传说的图。默认值为bubble_plot_labels.LEVELS=NULL。


参数：bubble_plot_labels.BUBBLE_TIPS_LINES
A list of labels that appear in the mouse over data tips. Should be of same length as the list from bubble_plot_data.BUBBLE_TIPS_LINES.  Default value is bubble_plot_labels.BUBBLE_TIPS_LINES=list('Median SGP (Count)', 'Percent at/above Proficient').  
标签的列表中出现的鼠标数据提示。应该是相同的长度的名单，bubble_plot_data.BUBBLE_TIPS_LINES。默认值为bubble_plot_labels.BUBBLE_TIPS_LINES=list('Median SGP (Count)', 'Percent at/above Proficient')。


参数：bubble_plot_labels.BUBBLE_TITLES
A character vector with of the same length as number of points plotted indicated what name should appear on each mouse over bubble tip (e.g., the school name associated  with the bubble.  Default value is bubble_plot_labels.BUBBLE_TITLES=SCHOOL_NAME,  
绘制的点数相同长度的字符向量表示什么名字应该出现在每个鼠标的泡沫头（例如，学校名称的泡沫。默认值是bubble_plot_labels.BUBBLE_TITLES=SCHOOL_NAME


参数：bubble_plot_titles.MAIN
The main title of the bubble plot. Default value is bubble_plot_titles.MAIN='Growth and Achievement'.  
气泡图的主标题。默认值为bubble_plot_titles.MAIN='Growth and Achievement'。


参数：bubble_plot_titles.SUB1
The right upper title of the bubble plot. Default value is bubble_plot_titles.SUB1='State School Performance'.  
右上标题的气泡图。默认值为bubble_plot_titles.SUB1='State School Performance'。


参数：bubble_plot_titles.SUB2
The right lower title of the bubble plot. Default value is bubble_plot_titles.SUB2='Growth & Current Achievement'.  
右下的气泡图的标题。默认值为bubble_plot_titles.SUB2='Growth & Current Achievement'。


参数：bubble_plot_titles.LEGEND1
The title of the upper legend to the right of the bubble plot. Default value is bubble_plot_titles.LEGEND1='School Size'.  
气泡图的右侧上的图例的标题。默认值为bubble_plot_titles.LEGEND1='School Size'。


参数：bubble_plot_titles.LEGEND2_P1
The 1st line of the title of the lower legend of the bubble plot. Default value is bubble_plot_titles.LEGEND2_P1=NULL.  
第一行的标题下传说中的气泡图。默认值为bubble_plot_titles.LEGEND2_P1=NULL。


参数：bubble_plot_titles.LEGEND2_P2
The 2nd line of the title of the lower legend of the bubble plot. Default value is bubble_plot_titles.LEGEND2_P2=NULL.  
第二行传说中的气泡图的标题。默认值为bubble_plot_titles.LEGEND2_P2=NULL。


参数：bubble_plot_configs.BUBBLE_MIN_MAX
A vector of length two indicating min and max values for the bubbles in inches. Default value is bubble_plot_configs.BUBBLE_MIN_MAX=c(0.03, 0.03).  
一个向量的长度，表示最小值和最大值中的气泡英寸。默认值为bubble_plot_configs.BUBBLE_MIN_MAX=c(0.03, 0.03)。


参数：bubble_plot_configs.BUBBLE_X_TICKS
A vector indicating what x coordinates to display for the x axis of the bubble plot. Default value is bubble_plot_configs.BUBBLE_X_TICKS=seq(0,100,10).  
一个向量x坐标为x轴的气泡图显示。默认值为bubble_plot_configs.BUBBLE_X_TICKS=seq(0,100,10)。


参数：bubble_plot_configs.BUBBLE_X_TICKS_SIZE
A vector, the same length as bubble_plot_configs.BUBBLE_X_TICKS indicating the character expansion (i.e., cex) associated with the characters. Default value is bubble_plot_configs.BUBBLE_X_TICKS_SIZE=c(rep(0.6, 5), 1, rep(0.6, 5)).  
的向量，相同的长度bubble_plot_configs.BUBBLE_X_TICKS表示的字符与字符相关联的扩展（即，CEX）。默认值为bubble_plot_configs.BUBBLE_X_TICKS_SIZE=c(rep(0.6, 5), 1, rep(0.6, 5))。


参数：bubble_plot_configs.BUBBLE_X_BANDS
A vector of cutpoints used to separate the plot background into horizontal rectangular regions.  
一个向量分开的图背景的横长方形区域的分割点。


参数：bubble_plot_configs.BUBBLE_X_BAND_LABELS
A character vector of labels used to labels the rectangles produced with bubble_plot_configs.BUBBLE_X_BANDS.  
一个字符向量的标签，标签的矩形与bubble_plot_configs.BUBBLE_X_BANDS。


参数：bubble_plot_configs.BUBBLE_Y_TICKS
A vector indicating what x coordinates to display for the x axis of the bubble plot. Default value is bubble_plot_configs.BUBBLE_Y_TICKS=seq(0,100,10).  
一个向量x坐标为x轴的气泡图显示。默认值为bubble_plot_configs.BUBBLE_Y_TICKS=seq(0,100,10)。


参数：bubble_plot_configs.BUBBLE_Y_TICKS_SIZE
A vector, the same length as bubble_plot_configs.BUBBLE_Y_TICKS indicating the character expansion (i.e., cex) associated with the characters. Default value is bubble_plot_configs.BUBBLE_Y_TICKS_SIZE=rep(0.6, 11).  
的向量，相同的长度bubble_plot_configs.BUBBLE_Y_TICKS表示的字符与字符相关联的扩展（即，CEX）。默认值为bubble_plot_configs.BUBBLE_Y_TICKS_SIZE=rep(0.6, 11)。


参数：bubble_plot_configs.BUBBLE_Y_BANDS
A vector of cutpoints used to separate the plot background into horizontal rectangular regions.  
一个向量分开的图背景的横长方形区域的分割点。


参数：bubble_plot_configs.BUBBLE_Y_BAND_LABELS
A character vector of labels used to labels the rectangles produced with bubble_plot_configs.BUBBLE_X_BANDS.  
一个字符向量的标签，标签的矩形与bubble_plot_configs.BUBBLE_X_BANDS。


参数：bubble_plot_configs.BUBBLE_SUBSET_INCREASE
Default value is bubble_plot_configs.BUBBLE_SUBSET_INCREASE=0.  
默认值为bubble_plot_configs.BUBBLE_SUBSET_INCREASE=0。


参数：bubble_plot_configs.BUBBLE_SUBSET_ALPHA
Default value is bubble_plot_configs.BUBBLE_SUBSET_ALPHA=list(Transparent=0.3, Opaque=0.95).  
默认值为bubble_plot_configs.BUBBLE_SUBSET_ALPHA=list(Transparent=0.3, Opaque=0.95)。


参数：bubble_plot_configs.BUBBLE_COLOR
Default value is bubble_plot_configs.BUBBLE_COLOR="deeppink2".  
默认值为bubble_plot_configs.BUBBLE_COLOR="deeppink2"。


参数：bubble_plot_configs.BUBBLE_COLOR_GRADIENT_REVERSE
Boolean arugment (defaults to FALSE) indicating whether to reverse color gradient associated with bubbles.  
的布尔arugment（默认为false）表示是否要扭转与气泡的颜色渐变。


参数：bubble_plot_configs.BUBBLE_TIPS
Default value is bubble_plot_configs.BUBBLE_TIPS=TRUE.  
默认值为bubble_plot_configs.BUBBLE_TIPS=TRUE。


参数：bubble_plot_configs.BUBBLE_PLOT_DEVICE
Default value is bubble_plot_configs.BUBBLE_PLOT_DEVICE='PDF'.  
默认值为bubble_plot_configs.BUBBLE_PLOT_DEVICE='PDF'。


参数：bubble_plot_configs.BUBBLE_PLOT_FORMAT
Default value is bubble_plot_configs.BUBBLE_PLOT_FORMAT='print'.  
默认值为bubble_plot_configs.BUBBLE_PLOT_FORMAT='print'。


参数：bubble_plot_configs.BUBBLE_PLOT_LEGEND
Default value is bubble_plot_configs.BUBBLE_PLOT_LEGEND=FALSE.  
默认值为bubble_plot_configs.BUBBLE_PLOT_LEGEND=FALSE。


参数：bubble_plot_configs.BUBBLE_PLOT_TITLE
Default value is bubble_plot_configs.BUBBLE_PLOT_TITLE=TRUE.  
默认值为bubble_plot_configs.BUBBLE_PLOT_TITLE=TRUE。


参数：bubble_plot_configs.BUBBLE_PLOT_BACKGROUND_LABELS
Default value is bubble_plot_configs.BUBBLE_PLOT_BACKGROUND_LABELS=c('Growth', 'Achievement').  
默认值为bubble_plot_configs.BUBBLE_PLOT_BACKGROUND_LABELS=c('Growth', 'Achievement')。


参数：bubble_plot_configs.BUBBLE_PLOT_EXTRAS
Default value is bubble_plot_configs.BUBBLE_PLOT_EXTRAS=NULL.  
默认值为bubble_plot_configs.BUBBLE_PLOT_EXTRAS=NULL。


参数：bubble_plot_configs.BUBBLE_PLOT_DIMENSION
Default value is bubble_plot_configs.BUBBLE_PLOT_DIMENSION=NULL.  
默认值为bubble_plot_configs.BUBBLE_PLOT_DIMENSION=NULL。


参数：bubble_plot_configs.BUBBLE_PLOT_NAME
Default value is bubble_plot_configs.BUBBLE_PLOT_NAME='bubblePlot.pdf'.  
默认值为bubble_plot_configs.BUBBLE_PLOT_NAME='bubblePlot.pdf'。


参数：bubble_plot_configs.BUBBLE_PLOT_PATH
Default value is bubble_plot_configs.BUBBLE_PLOT_PATH=paste('Figures', sep='').  
默认值为bubble_plot_configs.BUBBLE_PLOT_PATH=paste('Figures', sep='')。


参数：bubble_plot_pdftk.CREATE_CATALOG
Default value is bubble_plot_pdftk.CREATE_CATALOG=FALSE.   
默认值为bubble_plot_pdftk.CREATE_CATALOG=FALSE。


Details

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

Typical use of the function is as part of visualizeSGP function. However, function can be used more generically for diverse plots showing many dimensions of data simultaneously.
典型使用的功能是作为visualizeSGP功能的一部分。但是，函数可以用于更一般地为不同的图，同时许多方面的数据。


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

Function creates a bubble chart and writes the result as a PDF to bubble_plot_configs.BUBBLE_PATH.
函数创建一个气泡图，并把结果写入一个PDF bubble_plot_configs.BUBBLE_PATH。


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


Damian W. Betebenner <a href="mailto:dbetebenner@nciea.org">dbetebenner@nciea.org</a>

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


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