as.document.submission: Coerce a submission object to a document.

Description Usage Arguments Details

Description

Coerces a submission object to a document.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
## S3 method for class 'submission'
as.document(
  x,
  title,
  short = title,
  protocol = "~",
  sponsor = "~",
  program = "~",
  author = "~",
  date = "\\mydate \\today",
  lhead1 = short,
  lhead2 = protocol,
  rhead1 = sponsor,
  rhead2 = program,
  lfoot = author,
  rfoot = date,
  logo = NULL,
  logoscale = 1,
  morePreamble = NULL,
  geoLeft = "1in",
  geoRight = "1in",
  geoTop = "1in",
  geoBottom = "1in",
  pagestyle = NULL,
  thispagestyle = NULL,
  units = FALSE,
  ...
)

Arguments

x

a list of artifacts each having attributes: x, tag, des, file, spec

title

a title for the document

short

short title

protocol

relevant protocol

sponsor

program sponsor

program

drug development program

author

document author

date

today's date by default

lhead1

left header 1, e.g. short title

lhead2

left header 2, e.g. relevant protocol(s)

rhead1

right header 1, e.g. sponsor

rhead2

right header 2, e.g. development program

lfoot

left footer (italicized), e.g. responsible party

rfoot

right footer, today's date by default

logo

file path for title page logo

logoscale

size adjustment for logo

morePreamble

if NULL, a special value is passed to latexpdf::as.document.character. See function definition for details, and override if necessary.

geoLeft

passed to latexpdf::as.document.character

geoRight

passed to latexpdf::as.document.character

geoTop

passed to latexpdf::as.document.character

geoBottom

passed to latexpdf::as.document.character

pagestyle

passed to latexpdf::as.document.character

thispagestyle

passed to latexpdf::as.document.character

units

Should units for continuous variables be printed in Codes column?

...

passed to as.define, as.tabular, as.document.character

Details

Makes a pdf-ready character object representing a latex document. Essentially a wrapper for as.document. Title, logo, headers, footers, date are placed on the title page. The second page has a menu (table) of defined objects that creates bi-directional links to any defined data tables. Links are also created to the storage locations relative to the (resulting) define.pdf. Following pages table the attributes of data items in any datasets.


define documentation built on July 1, 2020, 6:25 p.m.