apa.table: Generic method to generate an APA style table for MS Word
In apaStyle: Generate APA Tables for MS Word

Description Usage Arguments Details Value Examples

View source: R/apaTable.R

Generic method to generate an APA style table for MS Word

apa.table(data = data.frame(), level1.header = NULL,
  level1.colspan = NULL, level2.header = NULL, number = "XX",
  title = "APA Table", filename = "APA Table.docx", note = NULL,
  landscape = FALSE, save = TRUE)

`data`	Dataset with statistics.
`level1.header`	The column names for the first header in the table.
`level1.colspan`	(optional) The colspan for the first header column.
`level2.header`	(optional) The column names for the second header in the table.
`number`	(optional) The table number in the document.
`title`	(optional) Name of the table.
`filename`	(optional) Specify the filename (including valid '`.docx`' extension).
`note`	(optional) Add a footnote to the bottom of the table.
`landscape`	(optional) Set (`TRUE`) if the table should be generated in landscape mode.
`save`	(optional) Set (`FALSE`) if the table should not be saved in a document.

This method can generate tables with two headers. If two headers are required, it is necesary to specifify the colspan for the upper level (level1.colspan). If only one header is required only the header items need to be specified for level1.header, and level1.colspan and level2.header do not need be specified.

This method allows users to specify a column in which either the level of significance (header: "*"), or a subscript (header: "_") is given. For example, when there is a column with a F-value and there shouldn't be an additional column with the corresponding p-values, it is possible to specify an additional column with significant values (i.e., +p < .10; *p < .05; **p < .01; ***p < .001) which will be merged as one column in the final table.

Often it is necesary to provide a table with the means from different groups or conditions. Using the subscript header ("_") it is possible to supply a column with subscripts which indicates which means on a row significantly differ from each other.

apa.table object; a list consisting of

`succes`	message in case of an error
`save`	flag which indicates whether the document is saved
`table`	`FlexTable {ReporteRs}` object

# Use apa.table function with a minimum of parameters
# Specify statistics
example <- data.frame(
  c("Column 1", "Column 2", "Column 3"),
  c(3.45, 5.21, 2.64),
  c(1.23, 1.06, 1.12)
)

# Create table
apa.table(data = example, level1.header = c("Variable", "M", "SD"))

# Create a table with two headers
# Specify statistics
example <- data.frame(
  c("Column 1", "Column 2", "Column 3"),
  c(3.45, 5.21, 2.64),
  c(1.23, 1.06, 1.12),
  c(8.22, 25.12, 30.27),
  c("+", "**", "***")
)

# Run method and preview table
apa.table(
  data = example,
  level1.header = c("", "Descriptives", "Inferential"),
  level1.colspan = c(1, 2, 2),
  level2.header = c("Variable", "M", "SD", "t-value", "*")
)$table