mnras_article.Rd 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/mnras_article.R
  3. \name{mnras_article}
  4. \alias{mnras_article}
  5. \title{Monthly Notices of the Royal Astronomical Society (MNRAS) Journal format.}
  6. \usage{
  7. mnras_article(..., keep_tex = TRUE, md_extensions = c(),
  8. fig_caption = TRUE)
  9. }
  10. \arguments{
  11. \item{...}{Arguments to \code{rmarkdown::pdf_document}}
  12. \item{keep_tex}{Keep the intermediate tex file used in the conversion to PDF}
  13. \item{md_extensions}{Markdown extensions to be added or removed from the
  14. default definition or R Markdown. See the \code{\link{rmarkdown_format}} for
  15. additional details.}
  16. \item{fig_caption}{\code{TRUE} to render figures with captions}
  17. }
  18. \value{
  19. R Markdown output format to pass to \code{\link[rmarkdown:render]{render}}
  20. }
  21. \description{
  22. Format for creating an Monthly Notices of Royal Astronomical Society (MNRAS) Journal articles.
  23. Adapted from
  24. \href{https://www.ras.org.uk/news-and-press/2641-new-version-of-the-mnras-latex-package}{https://www.ras.org.uk/news-and-press/2641-new-version-of-the-mnras-latex-package}.
  25. }
  26. \examples{
  27. \dontrun{
  28. library(rmarkdown)
  29. draft("MyArticle.Rmd", template = "mnras_article", package = "rticles")
  30. }
  31. }