Footnotes Method (R)

.Footnotes(object,categories,footnotes). Used to add a footnote to a table cell. The argument object is a reference to the associated BasePivotTable object. The argument categories is a list of categories specifying the cell for which a footnote is to be added. Each element in the list must be a CellText object (one of CellText.Number, CellText.String, CellText.VarName, or CellText.VarValue). The argument footnotes is a string specifying the footnote.

Example

table = spss.BasePivotTable("Table Title",
                            "OMS table subtype")

rowdim=BasePivotTable.Append(table,Dimension.Place.row,"rowdim")
coldim=BasePivotTable.Append(table,Dimension.Place.column,"coldim")

row_cat = spss.CellText.String("row1")
col_cat = spss.CellText.String("column1")

BasePivotTable.SetCategories(table,rowdim,row_cat)
BasePivotTable.SetCategories(table,coldim,col_cat)

BasePivotTable.SetCellValue(table,list(row_cat,col_cat),spss.CellText.String("cell value"))
BasePivotTable.Footnotes(table,list(row_cat,col_cat),
                         "Footnote for the cell specified by the categories row1 and column1")
  • The order in which dimensions are added to the table, either through a call to Append or to Insert, determines the order in which categories should be specified when providing the dimension coordinates for a particular cell. In the present example, the dimension rowdim is added first and coldim second, so the first element of list(row_cat,col_cat) specifies a category of rowdim and the second element specifies a category of coldim.