sim_article.Rd 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/sim_article.R
  3. \name{sim_article}
  4. \alias{sim_article}
  5. \title{Statistics in Medicine format.}
  6. \usage{
  7. sim_article(..., highlight = NULL, citation_package = "natbib")
  8. }
  9. \arguments{
  10. \item{...}{Additional arguments to \code{rmarkdown::pdf_document}}
  11. \item{highlight}{Syntax highlighting style. Supported styles include
  12. "default", "tango", "pygments", "kate", "monochrome", "espresso",
  13. "zenburn", and "haddock". Pass \code{NULL} to prevent syntax highlighting.}
  14. \item{citation_package}{The LaTeX package to process citations, \code{natbib}
  15. or \code{biblatex}. Use \code{none} if neither package is to be used.}
  16. }
  17. \value{
  18. R Markdown output format to pass to
  19. \code{\link[rmarkdown:render]{render}}
  20. }
  21. \description{
  22. Format for creating submissions to Statistics in Medicine. Based on the official Statistics in Medicine
  23. \href{http://onlinelibrary.wiley.com/journal/10.1002/(ISSN)1097-0258/homepage/la_tex_class_file.htm}{class}.
  24. }
  25. \details{
  26. Possible arguments for the YAML header are:
  27. \itemize{
  28. \item \code{title} title of the manuscript
  29. \item \code{author} list of authors, containing \code{name} and \code{num}
  30. \item \code{address} list containing \code{num} and \code{org} for defining \code{author} affiliations
  31. \item \code{presentaddress} not sure what they mean with this
  32. \item \code{corres} author and address for correspondence
  33. \item \code{authormark} short author list for header
  34. \item \code{received}, \code{revised}, \code{accepted} dates of submission, revision, and acceptance of the manuscript
  35. \item \code{abstract} abstract, limited to 250 words
  36. \item \code{keywords} up to 6 keywords
  37. \item \code{bibliography} BibTeX \code{.bib} file
  38. \item \code{classoption} options of the \code{WileyNJD-v2} class
  39. \item \code{longtable} set to \code{true} to include the \code{longtable} package, used by default from \code{pandoc} to convert markdown to LaTeX code
  40. \item \code{header-includes}: custom additions to the header, before the \code{\\begin\{document\}} statement
  41. \item \code{include-after}: for including additional LaTeX code before the \code{\\end\{document\}} statement}
  42. }
  43. \examples{
  44. \dontrun{
  45. library(rmarkdown)
  46. draft("MyArticle.Rmd", template = "sim_article", package = "rticles")
  47. }
  48. }