skeleton.Rmd 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211
  1. ---
  2. journal: jhm
  3. layout: draft
  4. title: Title here
  5. author1: Andrew N. Other
  6. author2: Fred T. Secondauthor
  7. currentaddress: "Current address: Some other place, Germany"
  8. affiliation: "American Meteorological Society,Boston, Massachusetts"
  9. exauthors:
  10. - name: Ping Lu
  11. exaffiliation: Princeton University
  12. correspondingauthor: "American Meteorological Society, 45 Beacon St., Boston, MA 02108."
  13. email: \email{[email protected]}
  14. - name: Miao Yu
  15. exaffiliation: University of Waterloo
  16. currentaddress: "Current address: Some other place, Canada"
  17. abstract: |
  18. Enter the text of your abstract here. This is a sample American Meteorological Society (AMS) \LaTeX\ template. This document provides authors with instructions on the use of the AMS \LaTeX\ template. Authors should refer to the file amspaper.tex to review the actual \LaTeX\ code used to create this document. The template.tex file should be modified by authors for their own manuscript.
  19. bibliography: amstest.bib
  20. output: rticles::ams_article
  21. ---
  22. # Introduction
  23. This document will provide authors with the basic American Meteorological Society (AMS) formatting guidelines. This document was created using \LaTeX\ and demonstrates how to use the \LaTeX\ template when submitting a manuscript to the AMS. The following sections will outline the guidelines and formatting for text, math, figures, and tables while using \LaTeX\/ for a submission to the AMS. An attempt to compile amspaper.tex should be made before using the template. The files have been tested on Windows, Linux, and Mac OS using \TeX\ Live 2011 (available online at \url{http://www.tug.org/texlive/}). Feedback and questions should be sent to [email protected]. Additional information is available on the AMS \LaTeX\ Submission Info web page (\url{http://www2.ametsoc.org/ams/index.cfm/publications/authors/journal-and-bams-authors/author-resources/latex-author-info/}).
  24. Authors should use the empty template.tex to begin their paper. A valuable source of \LaTeX\ information is the {TeX Frequently Asked Questions} page (available online at \url{faq.tug.org}).
  25. # Formatting text and sections
  26. The text should be divided into sections, each with a separate heading and consecutive numbering. Note, however, that single secondary, tertiary, and quaternary sections remain unnumbered. Each section heading should be placed on a separate line using the appropriate \LaTeX\ commands.
  27. ## Secondary headings {-}
  28. Secondary headings labeled with letters are formatted using the `## Secondary headings {-}` for a single subsection within a section or `## Secondary headings` for multiple subsections within one section.
  29. ### Tertiary headings {-}
  30. Tertiary headings are formatted using the `### Tertiary headings {-}` for single a subsubsection within a subsection or `### Tertiary headings` for multiple subsubsections within a subsection.
  31. \paragraph*{Quaternary headings}
  32. Quaternary headings are formatted using the `\paragraph*{Quaternary headings}` for a single paragraph within a subsubsection or `\paragraph{Quaternary headings}` for multiple paragraphs within a subsection.
  33. # Citations
  34. Citations to standard references in text should consist of the name of the author and the year of publication, for example, @poe12 or [@poe12;@alexander:2002;@Gershunov2012] using the appropriate `@key` or `[@key]` commands, respectively. A variety of citation formats can be used with the natbib package; however, the AMS prefers that authors use only the `@key` and `[@key]` commands. References should be entered in the references.bib file. For a thorough discussion of how to enter references into the references.bib database file following AMS style, please refer to the **AMS_Refs.pdf** document included in this package.
  35. # Formatting math
  36. The following sections will outline the basic formatting rules for mathematical symbols and units. In addition, a review of the amspaper.tex file will show how this is done with the use of \LaTeX\ commands. The AMS template provides the American Mathematical Society math, font, symbol, and boldface packages for use in math mode.
  37. ## Mathematical symbols
  38. Symbols must be of the same font style both in text discussion and in displayed equations or terms (and figures should be prepared to match). Scalar single-character symbols are set italic, Greek, or script. Examples are $u$, $L$ [note that $\upsilon$ (Greek upsilon) is used instead of *v* (italic "vee") to avoid confusion with $\nu$ (Greek nu) often used for viscosity; this is handled automatically when in \LaTeX\ math mode], $w$, $x$, $y$, $z$, $f$, $g$, $r$, indices such as $i$ or $j$, and constants such as $C_D$, $k$, or $K$. Multiple-character scalar variables, abbreviations, nondimensional numbers, and acronyms for variables are set regular nonitalic: $\mathrm{LWC}$, $\mathrm{Re}$, $\mathrm{Ro}$, $\mathrm{BT}$, $\mathrm{abs}$, $\mathrm{obs}$, $\mathrm{max}$, $\mathrm{min}$, $\mathrm{Re}$/$\mathrm{Im}$ (real/imaginary), etc. For vectors, use boldface nonitalic Times Roman as in $\mathbf{V}$, $\mathbf{v}$, or $\mathbf{x}$, and $\mathbf{i}$, $\mathbf{j}$, and $\mathbf{k}$ unit vectors. Do not use the \LaTeX\ $\backslash vec$ command to denote vectors. For matrix notation, use nonitalic boldface Arial (or sans serif) font as in $\pmb{\mathsf{A}}$, $\pmb{\mathsf{B}}$, or $\pmb{\mathsf{M}}$. Note that you will need to use the $\backslash$pmb command for boldface sans serif; the $\backslash$bm command will not work. All mathematical operator abbreviations/acronyms are set lowercase regular Roman font, except $O$ (on the order of): $\sin$, $\cos$, $\tan$, $\tanh$, $\mathrm{cov}$, $\Pr$ (for probability; note same as Prandtl number), $\mathrm{const}$ (for constant), $\mathrm{c.c.}$ (complex conjugate).
  39. ## Units
  40. Units are always set on a single line with a space separating the denominator, which is set with a superscript $-1$, $-2$, and so on, rather than using a slash for "per." Examples are g kg$^{-1}$, m$^2$ s$^{-1}$, Wm$^{-2}$, g m$^{-3}$, and m s$^{-1}$ (note that ms$^{-1}$ is the unit for "per millisecond").
  41. ## Equations
  42. Brief equations or terms set inline in text must be set as a single-line expression because page proofs are not double spaced, for example, $\rho^{-1}p/x$ or $(1/{\rho})p/x$ or $(a-b)/(c+d)$; that is, use a superscript $-1$ for the denominator. In case of a more complicated term or equation, it should be set as an unnumbered display equation, such as
  43. $$
  44. x=\frac{2b\pm\sqrt{b^{2}-4ac}}{2c}.
  45. $$
  46. Otherwise, numbered display equations can be entered using the appropriate equation command, such as
  47. \begin{equation}
  48. x=\frac{2b\pm\sqrt{b^{2}-4ac}}{2c}.
  49. \end{equation}
  50. Lists of equations are punctuated as written English, and commas, semicolons, and periods are placed where appropriate. Conjunctions such as "and", "while", "when", or "for" are also typically placed before the final element in a mathematical phrase, as befits the intended mathematical meaning.
  51. ## Figures and tables
  52. The AMS prefers that all figures and tables are placed **at the end of the document** prior to submission. A list of tables and a list of figures will appear near the end of the PDFfile, before the actual tables and figures. These lists are necessary for submission.
  53. For appendix figures and tables, special commands are needed to manually change the numbering to ensure that each appendix figure or table is numbered as part of the respective appendix and not as a continuation of the main paper. Use the command `\appendcaption{}` instead of the usual `caption{}` to adjust the numbering; for example, for Table A1, you would use the command `\appendcaption{A1}`.
  54. Note that the normal `\ref{}` command cannot be used to cite appendix figures and tables as the numbering will be incorrect. Callouts for appendix figures and tables in the text will need to be written out as plain text, for example, Fig. A1 and Table A1.
  55. ### Figures
  56. The insertion of a sample figure (Fig. \ref{f1})
  57. and caption is given below (in the .tex document) and at the end of the document. Standard figure sizes are 19 (one column), 27, 33, and 39 (two columns) picas.
  58. \begin{figure}[h]
  59. \centerline{\includegraphics[width=19pc]{figure01.pdf}}
  60. \caption{Enter the caption for your figure here. Repeat as
  61. necessary for each of your figures.}\label{f1}
  62. \end{figure}
  63. ```{r,echo=FALSE,fig.cap='test the rmd output',fig.align='center',fig.width=3.17}
  64. plot(1:10)
  65. ```
  66. ### Tables
  67. Each table must be numbered, provided with a caption, and mentioned specifically in the text.
  68. See below (in the .tex document) and at the end of the document for the formatting of a sample table (Table
  69. \ref{t1}).
  70. \begin{table}[h]
  71. \caption{This is a sample table caption and table layout.}\label{t1}
  72. \begin{center}
  73. \begin{tabular}{ccccrrcrc}
  74. \topline
  75. $N$ & $X$ & $Y$ & $Z$\\
  76. \midline
  77. 0000 & 0000 & 0010 & 0000 \\
  78. 0005 & 0004 & 0012 & 0000 \\
  79. 0010 & 0009 & 0020 & 0000 \\
  80. 0015 & 0016 & 0036 & 0002 \\
  81. 0020 & 0030 & 0066 & 0007 \\
  82. 0025 & 0054 & 0115 & 0024 \\
  83. \botline
  84. \end{tabular}
  85. \end{center}
  86. \end{table}
  87. \acknowledgments
  88. Keep acknowledgments (note correct spelling: no e between the g and m) as brief as possible. In general, acknowledge only direct help in writing or research. Financial support (e.g., grant numbers) for the work done, for an author, or for the laboratory where the work was performed is best acknowledged here rather than as footnotes to the title or to an author's name. Contribution numbers (if the work has been published by the author's institution or organization) should be included as footnotes on the title page,
  89. not in the acknowledgments.
  90. Please use The authors thank \ldots rather than The authors would like to thank \ldots.
  91. The author thanks Mats Dahlgren for version one of \textsf{achemso}, and Donald Arseneau for the code taken from \textsf{cite} to move citations after punctuation. Many users have provided feedback on the class, which is reflected in all of the different demonstrations shown in this document.
  92. \appendix[A]
  93. \appendixtitle{Title of Appendix}
  94. ## Appendix section
  95. The AMS template allows authors to format an unlimited number of appendixes. To format a single appendix, use the `\appendix` command with no additional argument. Otherwise, add the appropriate one-letter argument to the `\appendix` command (e.g. `\appendix[A]`, `\appendix[B]`, `\appendix[C]`, etc.) corresponding to the appropriate appendix.
  96. The title of the appendix can be formatted using the `\appendixtitle{} ` command. The `##` , `###` and `\paragraph` commands are used to create sections within the appendix. (Note that the appendix title takes the place of `#` in the appendix, so the first section should begin with `##` instead of `#`.)
  97. Equations are automatically numbered appropriately for each appendix. Here is an example of the first equation in appendix A, automatically labeled (\ref{eq:1}):
  98. \begin{equation}
  99. \label{eq:1}
  100. x=\frac{2b\pm\sqrt{b^{2}-4ac}}{2c}.
  101. \end{equation}
  102. For appendix figures and tables, special commands are needed to manually change the numbering to ensure that each appendix figure or table is numbered as part of the appendix and not as a continuation of the main paper. Use the command `\appendcaption{}` instead of the usual `\caption{}` to adjust the numbering; for example, for Table A1, you would use the command `\appendcaption{A1}`. In-text callouts for each appendix figure and table will need to be written as plain text;the usual `\ref{}` command cannot be used.
  103. \appendix[B]
  104. \appendixtitle{File Structure of the AMS \LaTeX\ Package}
  105. ## AMS \LaTeX\ files
  106. You will be provided with a tarred, zipped \LaTeX\ package containing 3 files. These files are
  107. \begin{description}
  108. \item
  109. your-paper-name.Rmd template for your paper
  110. \item
  111. amstest.bib an example of a bibliographic database file.
  112. \item
  113. figure01.pdf are sample figures.
  114. \end{description}
  115. ## Help for Authors
  116. Questions and feedback concerning the use of the AMS \LaTeX\ files should be directed to [email protected] or [email protected](for rmarkdown issues). Additional information is available on the AMS \LaTeX\ Submission Info web page (\url{http://www2.ametsoc.org/ams/index.cfm/publications/authors/journal-and-bams-authors/author-resources/latex-author-info/}).
  117. \appendix[C]
  118. \appendixtitle{Building a PDF and Submitting Your \LaTeX\ Manuscript Files to the AMS}
  119. ## Building your own PDF
  120. There are a variety of different methods and programs that will create a final PDF from your \LaTeX\ files. The easiest method is to download one of the freely available text editors/compilers such as Rstudio to compile your files into a PDF.
  121. ## Submitting your files to the AMS for peer review
  122. The AMS uses the Editorial Manager system for all author submissions for peer review. Editorial Manager uses the freely available \TeX\ Live 2011 distribution. This system will automatically generate a PDF from your submitted \LaTeX\ files and figures(not Rmd file, tex files will be produced when you successful knit your Rmd file).
  123. You should not upload your own PDF into the system. If the system does not build the PDF from your files correctly, refer to the AMS \LaTeX\ FAQ page first for possible solutions. If your PDF still does not build correctly after trying the solutions on the FAQ page, email [email protected] for help.
  124. ## Other software
  125. As mentioned above, there is a variety of software that can be used to edit .tex files and build a PDF. The AMS does not support \LaTeX\/-related WYSIWYG software, such as Scientific Workplace, or WYSIWYM software, such as LyX. \TeX\ Live (available online at \\ \url{http://www.tug.org/texlive/}) is recommended for users needing an up-to-date \LaTeX\ distribution with software that includes an editor and the ability to automatically generate a PDF.
  126. # References {-}
  127. \bibliography{references}
  128. \begin{table}
  129. \appendcaption{A1}{Here is the appendix table caption.}
  130. \centering
  131. \begin{tabular}{ccc}
  132. \topline
  133. $1$ & $2$ & $3$ \\
  134. \midline
  135. a&b&c \\
  136. d&e&f \\
  137. \botline
  138. \end{tabular}
  139. \end{table}
  140. \begin{figure}
  141. \centerline{(illustration here)}
  142. \appendcaption{A1}{Here is the appendix figure caption.}
  143. \end{figure}
  144. \begin{figure}
  145. \centerline{(illustration here)}
  146. \appendcaption{B1}{Here is the appendix figure caption.}
  147. \end{figure}