as.braid: Creates object of class braid.

Description Usage Arguments Value

View source: R/braid-object.R

Description

A braid object describes the data and meta-data in the survey that will be analysed by the analysis and reporting functions in the braid package.

Usage

1
2
3
4
5
  as.braid(path = tempdir(), graphics = "graphics",
    fileOuter = "outline.tex", fileInner = "braid.tex",
    counterStart = 1, defaultPlotSize = c(5, 3), dpi = 600,
    outputType = c("latex", "ppt", "device"),
    graphicFormat = c("pdf", "wmf"))

Arguments

path

Character vector: File path where latex output will be saved

graphics

Character vector: File path relative to pathOutput where to save graphics (this gets appended to pathOutput.)

fileOuter

Filename of latex outline file (used by braidCompile

fileInner

Filename where latex output will be saved (This gets appended to pathOutput)

counterStart

The starting number for a counter used to store graphs, defaults to 1

defaultPlotSize

Numeric vector of length 2: Plot size in inches, e.g. c(4, 3)

dpi

Dots per inch, passed to ggsave()

outputType

Character string specifying the destination of output: "latex", "ppt" or "device". If "device", graphs are sent to the default device (typically the RGgui plot terminal)

graphicFormat

Device type for saving graphic plots. Currently only pdf and wmf is supported.

Value

A list object of class braid


andrie/braid documentation built on June 3, 2017, 7:01 p.m.