startAppendix: Starts a new appendix

In CenterForAssessment/Literasee: Assessment Literacy Content Development via R

Starts a new appendix

Description

The function sets up the document to transition to appendix formatting, including section number resets (usually as a letter - e.g. Appendix A) and counter clearing.

Usage

startAppendix(
  appendix.number=1L,
  use.alpha=TRUE,
  set.counters=TRUE,
  table.name=NULL,
  figure.name=NULL)

Arguments

appendix.number	Numeric. Number to set to the appendix number. Default is 1, meaning the next appendix will be the first (Appendix A if use.alpha is true).
use.alpha	Boolean. Defaults to TRUE, meaning the appendix will will be the alphabetical letter corresponding to appendix.number.
set.counters	Boolean. Defaults to TRUE, meaning the setCounters function will be used to reset all table, figure and equation numbers to 0.
table.name	A character string indicating how tables should be prefaced. Defaults to NULL, which provides ‘**Table A%s:**’ for tables in Appendix A, etc. Note that ‘%s’ will be substituted for the table number.
figure.name	A character string indicating how figures should be prefaced. Defaults to NULL, which provides ‘**Figure A%d:** %s’ for figures in Appendix A (results in ‘Figure A1: Caption text’), etc. Note that ‘%d’ will be substituted for the table number and ‘%s’ will be substituted for the caption text provided (if any).

Examples

  ## Not run: 
    startAppendix()
  
## End(Not run)

CenterForAssessment/Literasee documentation built on July 2, 2023, 6:21 p.m.