Create and render 'rmarkdown' file

Function to create a 'rmarkdown' file with all the output and render it

Usage

create_rmd(
  x,
  output_file,
  output_format = "pdf_document",
  preprocessing_fun = print_preprocessing,
  decomposition_fun = print_decomposition,
  diagnostics_fun = print_diagnostics,
  title = "Seasonal adjustment summary",
  knitr_chunk_opts = list(fig.pos = "h", echo = FALSE, results = "asis", fig.cap =
    "S-I Ratio"),
  ...
)

# S3 method for class 'SA'
create_rmd(
  x,
  output_file,
  output_format = "pdf_document",
  preprocessing_fun = print_preprocessing,
  decomposition_fun = print_decomposition,
  diagnostics_fun = print_diagnostics,
  title = "Seasonal adjustment summary",
  knitr_chunk_opts = list(fig.pos = "h", echo = FALSE, results = "asis", fig.cap =
    "S-I Ratio"),
  ...
)

# S3 method for class 'jSA'
create_rmd(
  x,
  output_file,
  output_format = "pdf_document",
  preprocessing_fun = print_preprocessing,
  decomposition_fun = print_decomposition,
  diagnostics_fun = print_diagnostics,
  title = "Seasonal adjustment summary",
  knitr_chunk_opts = list(fig.pos = "h", echo = FALSE, results = "asis", fig.cap =
    "S-I Ratio"),
  ...
)

# S3 method for class 'workspace'
create_rmd(
  x,
  output_file,
  output_format = "pdf_document",
  preprocessing_fun = print_preprocessing,
  decomposition_fun = print_decomposition,
  diagnostics_fun = print_diagnostics,
  title = "Seasonal adjustment summary",
  knitr_chunk_opts = list(fig.pos = "h", echo = FALSE, results = "asis", fig.cap =
    "S-I Ratio"),
  ...
)

# S3 method for class 'multiprocessing'
create_rmd(
  x,
  output_file,
  output_format = "pdf_document",
  preprocessing_fun = print_preprocessing,
  decomposition_fun = print_decomposition,
  diagnostics_fun = print_diagnostics,
  title = "Seasonal adjustment summary",
  knitr_chunk_opts = list(fig.pos = "h", echo = FALSE, results = "asis", fig.cap =
    "S-I Ratio"),
  ...,
  workspace
)

# S3 method for class 'sa_item'
create_rmd(
  x,
  output_file,
  output_format = "pdf_document",
  preprocessing_fun = print_preprocessing,
  decomposition_fun = print_decomposition,
  diagnostics_fun = print_diagnostics,
  title = "Seasonal adjustment summary",
  knitr_chunk_opts = list(fig.pos = "h", echo = FALSE, results = "asis", fig.cap =
    "S-I Ratio"),
  ...,
  workspace
)

Arguments

x

the object to render: it can be a "SA", "jSA", "sa_item", "multiprocessing" or "workspace" object

output_file

the name of the output `rmarkdown` file.

output_format

the R Markdown output format to convert to: "pdf_document" for a pdf output, "html_document" for a HTML output. See render for more details.

preprocessing_fun

the function used to print the preprocessing. print_preprocessing by default. If preprocessing_fun = NULL the function is not used.

decomposition_fun

the function used to print the decomposition print_decomposition by default. If decomposition_fun = NULL the function is not used.

diagnostics_fun

the function used to print the diagnostics print_diagnostics by default. If diagnostics_fun = NULL the function is not used.

title

the title of the R Markdown document.

knitr_chunk_opts

options for R code chunks. See opts_chunk for more details.

...

other arguments to pass to render.

workspace

the workspace. Only used when x is a "sa_item" or "multiprocessing".

Examples

# \donttest{
ipi <- RJDemetra::ipi_c_eu[, "FR"]
jsa_x13 <- RJDemetra::jx13(ipi)

output_file <- tempfile(fileext = ".Rmd")
create_rmd(jsa_x13, output_file, output_format = "pdf_document")
#> 
#> 
#> processing file: file22517b7d67f1.Rmd
#> 1/5                  
#> 2/5 [setup]          
#> 3/5                  
#> 4/5 [unnamed-chunk-1]
#> Error in eval(expr, envir, enclos): object 'jsa_x13' not found
#> 
#> Quitting from lines 21-24 [unnamed-chunk-1] (file22517b7d67f1.Rmd)
# To directly open the pdf:
browseURL(sub(".Rmd",".pdf", output_file, fixed = TRUE))


# To create a pdf from a workspace:
jsa_ts <- jtramoseats(ipi)
wk <- new_workspace()
mp <- new_multiprocessing(wk, "sa1")
add_sa_item(wk, "sa1", jsa_x13, "X13")
add_sa_item(wk, "sa1", jsa_ts, "TramoSeats")

# It's important to compute the workspace to be able
# to import the models
compute(wk)

output_file <- tempfile(fileext = ".Rmd")
create_rmd(wk, output_file, 
           output_format = c("pdf_document", "html_document"),
           output_options = list(toc = TRUE,
                                 number_sections = TRUE))
#> 
#> 
#> processing file: file225131d6beec.Rmd
#> 1/17                  
#> 2/17 [setup]          
#> 3/17                  
#> 4/17 [unnamed-chunk-1]
#> Error in eval(expr, envir, enclos): object 'wk' not found
#> 
#> Quitting from lines 21-22 [unnamed-chunk-1] (file225131d6beec.Rmd)
# To open the file:
browseURL(sub(".Rmd",".pdf", output_file, fixed = TRUE))
browseURL(sub(".Rmd",".html", output_file, fixed = TRUE))
# }