Skip to content

Commit f496aa2

Browse files
committed
Attempt to update Wellcome OR latex template
1 parent 320d850 commit f496aa2

File tree

19 files changed

+898
-3
lines changed

19 files changed

+898
-3
lines changed

DESCRIPTION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ Authors@R: c(
4747
person("Alfredo", "Hernández", role = c("ctb"), email = "aldomann.designs@gmail.com", comment = c(ORCID = "0000-0002-2660-4545")),
4848
person("Stefano", "Coretta", role = c("ctb"), email = "stefano.coretta@gmail.com", comment = c(ORCID = "0000-0001-9627-5532", github = "stefanocoretta")),
4949
person("Alvaro", "Uzaheta", role = c("ctb"), email = "alvaro.uzaheta@gess.ethz.ch", comment = c(github = "auzaheta"))
50+
person("Callum", "Arnold", role = c("ctb"), email = "cal.rk.arnold@gmail.com", comment = c(github = "arnold-c"))
5051
)
5152
Description: A suite of custom R Markdown formats and templates for
5253
authoring journal articles and conference submissions.

NAMESPACE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ export(sage_article)
3737
export(sim_article)
3838
export(springer_article)
3939
export(tf_article)
40+
export(wellcomeor_article)
4041
importFrom(rmarkdown,includes_to_pandoc_args)
4142
importFrom(rmarkdown,knitr_options)
4243
importFrom(rmarkdown,output_format)

NEWS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# rticles 0.22
2+
3+
- Add `wellcomeor_article()` template.
4+
15
# rticles 0.21
26

37
- All templates have now the `$highlighting-macros$` variables required for Pandoc highlighting (#435).

R/article.R

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -418,3 +418,13 @@ tf_article <- function(..., keep_tex = TRUE, citation_package = 'natbib') {
418418
"tf", keep_tex = keep_tex, citation_package = citation_package, ...
419419
)
420420
}
421+
422+
#' @section \code{wellcomeor_article}: Format for creating submissions to
423+
#' Wellcome Open Research. Adapted from \url{https://www.overleaf.com/project/6131911644b635ad3aaa4cb2}.
424+
#' @export
425+
#' @rdname article
426+
wellcomeor_article <- function(..., keep_tex = TRUE, citation_package = 'default') {
427+
pdf_document_format(
428+
"wellcomeor", keep_tex = keep_tex, citation_package = citation_package, ...
429+
)
430+
}

README.Rmd

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ Currently included templates and their contributors are the following:
7777
| [SIM: Statistics in Medicine](https://onlinelibrary.wiley.com/journal/10970258) | [\@ellessenne](https://github.com/ellessenne)| [\#231](https://github.com/rstudio/rticles/pull/231) | `sim_article()`|
7878
| [Taylor & Francis](https://www.tandfonline.com/)| [\@dleutnant](https://github.com/dleutnant)| [\#218](https://github.com/rstudio/rticles/pull/218) | `tf_article()` |
7979
| [The R Journal](https://journal.r-project.org/) ||| `rjournal_article()` |
80+
| [Wellcome Open Research](https://wellcomeopenresearch.org) | [\@arnold-c](https://github.com/arnold-c) | | `r wellcomeor_article()`|
8081

8182
You can also get the list of available journal names with `rticles::journals()`.
8283

Binary file not shown.
Lines changed: 335 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,335 @@
1+
\documentclass{article}
2+
3+
\usepackage{arxiv}
4+
5+
\usepackage[utf8]{inputenc} % allow utf-8 input
6+
\usepackage[T1]{fontenc} % use 8-bit T1 fonts
7+
\usepackage{lmodern} % https://github.com/rstudio/rticles/issues/343
8+
\usepackage{hyperref} % hyperlinks
9+
\usepackage{url} % simple URL typesetting
10+
\usepackage{booktabs} % professional-quality tables
11+
\usepackage{amsfonts} % blackboard math symbols
12+
\usepackage{nicefrac} % compact symbols for 1/2, etc.
13+
\usepackage{microtype} % microtypography
14+
\usepackage{graphicx}
15+
16+
\title{A template for the \emph{arxiv} style}
17+
18+
\author{
19+
David S. Hippocampus
20+
\thanks{Use footnote for providing further information about author
21+
(webpage, alternative address)---\emph{not} for acknowledging funding
22+
agencies. Optional.}
23+
\\
24+
Department of Computer Science \\
25+
Cranberry-Lemon University \\
26+
Pittsburgh, PA 15213 \\
27+
\texttt{\href{mailto:hippo@cs.cranberry-lemon.edu}{\nolinkurl{hippo@cs.cranberry-lemon.edu}}} \\
28+
\And
29+
Elias D. Striatum
30+
\\
31+
Department of Electrical Engineering \\
32+
Mount-Sheikh University \\
33+
Santa Narimana, Levand \\
34+
\texttt{\href{mailto:stariate@ee.mount-sheikh.edu}{\nolinkurl{stariate@ee.mount-sheikh.edu}}} \\
35+
}
36+
37+
\usepackage{color}
38+
\usepackage{fancyvrb}
39+
\newcommand{\VerbBar}{|}
40+
\newcommand{\VERB}{\Verb[commandchars=\\\{\}]}
41+
\DefineVerbatimEnvironment{Highlighting}{Verbatim}{commandchars=\\\{\}}
42+
% Add ',fontsize=\small' for more characters per line
43+
\usepackage{framed}
44+
\definecolor{shadecolor}{RGB}{248,248,248}
45+
\newenvironment{Shaded}{\begin{snugshade}}{\end{snugshade}}
46+
\newcommand{\AlertTok}[1]{\textcolor[rgb]{0.94,0.16,0.16}{#1}}
47+
\newcommand{\AnnotationTok}[1]{\textcolor[rgb]{0.56,0.35,0.01}{\textbf{\textit{#1}}}}
48+
\newcommand{\AttributeTok}[1]{\textcolor[rgb]{0.77,0.63,0.00}{#1}}
49+
\newcommand{\BaseNTok}[1]{\textcolor[rgb]{0.00,0.00,0.81}{#1}}
50+
\newcommand{\BuiltInTok}[1]{#1}
51+
\newcommand{\CharTok}[1]{\textcolor[rgb]{0.31,0.60,0.02}{#1}}
52+
\newcommand{\CommentTok}[1]{\textcolor[rgb]{0.56,0.35,0.01}{\textit{#1}}}
53+
\newcommand{\CommentVarTok}[1]{\textcolor[rgb]{0.56,0.35,0.01}{\textbf{\textit{#1}}}}
54+
\newcommand{\ConstantTok}[1]{\textcolor[rgb]{0.00,0.00,0.00}{#1}}
55+
\newcommand{\ControlFlowTok}[1]{\textcolor[rgb]{0.13,0.29,0.53}{\textbf{#1}}}
56+
\newcommand{\DataTypeTok}[1]{\textcolor[rgb]{0.13,0.29,0.53}{#1}}
57+
\newcommand{\DecValTok}[1]{\textcolor[rgb]{0.00,0.00,0.81}{#1}}
58+
\newcommand{\DocumentationTok}[1]{\textcolor[rgb]{0.56,0.35,0.01}{\textbf{\textit{#1}}}}
59+
\newcommand{\ErrorTok}[1]{\textcolor[rgb]{0.64,0.00,0.00}{\textbf{#1}}}
60+
\newcommand{\ExtensionTok}[1]{#1}
61+
\newcommand{\FloatTok}[1]{\textcolor[rgb]{0.00,0.00,0.81}{#1}}
62+
\newcommand{\FunctionTok}[1]{\textcolor[rgb]{0.00,0.00,0.00}{#1}}
63+
\newcommand{\ImportTok}[1]{#1}
64+
\newcommand{\InformationTok}[1]{\textcolor[rgb]{0.56,0.35,0.01}{\textbf{\textit{#1}}}}
65+
\newcommand{\KeywordTok}[1]{\textcolor[rgb]{0.13,0.29,0.53}{\textbf{#1}}}
66+
\newcommand{\NormalTok}[1]{#1}
67+
\newcommand{\OperatorTok}[1]{\textcolor[rgb]{0.81,0.36,0.00}{\textbf{#1}}}
68+
\newcommand{\OtherTok}[1]{\textcolor[rgb]{0.56,0.35,0.01}{#1}}
69+
\newcommand{\PreprocessorTok}[1]{\textcolor[rgb]{0.56,0.35,0.01}{\textit{#1}}}
70+
\newcommand{\RegionMarkerTok}[1]{#1}
71+
\newcommand{\SpecialCharTok}[1]{\textcolor[rgb]{0.00,0.00,0.00}{#1}}
72+
\newcommand{\SpecialStringTok}[1]{\textcolor[rgb]{0.31,0.60,0.02}{#1}}
73+
\newcommand{\StringTok}[1]{\textcolor[rgb]{0.31,0.60,0.02}{#1}}
74+
\newcommand{\VariableTok}[1]{\textcolor[rgb]{0.00,0.00,0.00}{#1}}
75+
\newcommand{\VerbatimStringTok}[1]{\textcolor[rgb]{0.31,0.60,0.02}{#1}}
76+
\newcommand{\WarningTok}[1]{\textcolor[rgb]{0.56,0.35,0.01}{\textbf{\textit{#1}}}}
77+
78+
\usepackage{longtable,booktabs,array}
79+
\usepackage{calc} % for calculating minipage widths
80+
% Correct order of tables after \paragraph or \subparagraph
81+
\usepackage{etoolbox}
82+
\makeatletter
83+
\patchcmd\longtable{\par}{\if@noskipsec\mbox{}\fi\par}{}{}
84+
\makeatother
85+
% Allow footnotes in longtable head/foot
86+
\IfFileExists{footnotehyper.sty}{\usepackage{footnotehyper}}{\usepackage{footnote}}
87+
\makesavenoteenv{longtable}
88+
89+
% Pandoc citation processing
90+
\newlength{\csllabelwidth}
91+
\setlength{\csllabelwidth}{3em}
92+
\newlength{\cslhangindent}
93+
\setlength{\cslhangindent}{1.5em}
94+
% for Pandoc 2.8 to 2.10.1
95+
\newenvironment{cslreferences}%
96+
{}%
97+
{\par}
98+
% For Pandoc 2.11+
99+
\newenvironment{CSLReferences}[2] % #1 hanging-ident, #2 entry spacing
100+
{% don't indent paragraphs
101+
\setlength{\parindent}{0pt}
102+
% turn on hanging indent if param 1 is 1
103+
\ifodd #1 \everypar{\setlength{\hangindent}{\cslhangindent}}\ignorespaces\fi
104+
% set entry spacing
105+
\ifnum #2 > 0
106+
\setlength{\parskip}{#2\baselineskip}
107+
\fi
108+
}%
109+
{}
110+
\usepackage{calc} % for calculating minipage widths
111+
\newcommand{\CSLBlock}[1]{#1\hfill\break}
112+
\newcommand{\CSLLeftMargin}[1]{\parbox[t]{\csllabelwidth}{#1}}
113+
\newcommand{\CSLRightInline}[1]{\parbox[t]{\linewidth - \csllabelwidth}{#1}\break}
114+
\newcommand{\CSLIndent}[1]{\hspace{\cslhangindent}#1}
115+
116+
117+
118+
\begin{document}
119+
\maketitle
120+
121+
\def\tightlist{}
122+
123+
124+
\begin{abstract}
125+
Enter the text of your abstract here.
126+
\end{abstract}
127+
128+
\keywords{
129+
blah
130+
\and
131+
blee
132+
\and
133+
bloo
134+
\and
135+
these are optional and can be removed
136+
}
137+
138+
\hypertarget{introduction}{%
139+
\section{Introduction}\label{introduction}}
140+
141+
Here goes an introduction text
142+
143+
\hypertarget{headings-first-level}{%
144+
\section{Headings: first level}\label{headings-first-level}}
145+
146+
\label{sec:headings}
147+
148+
You can use directly LaTeX command or Markdown text.
149+
150+
LaTeX command can be used to reference other section. See Section
151+
\ref{sec:headings}. However, you can also use \textbf{bookdown}
152+
extensions mechanism for this.
153+
154+
\hypertarget{headings-second-level}{%
155+
\subsection{Headings: second level}\label{headings-second-level}}
156+
157+
You can use equation in blocks
158+
159+
\[
160+
\xi _{ij}(t)=P(x_{t}=i,x_{t+1}=j|y,v,w;\theta)= {\frac {\alpha _{i}(t)a^{w_t}_{ij}\beta _{j}(t+1)b^{v_{t+1}}_{j}(y_{t+1})}{\sum _{i=1}^{N} \sum _{j=1}^{N} \alpha _{i}(t)a^{w_t}_{ij}\beta _{j}(t+1)b^{v_{t+1}}_{j}(y_{t+1})}}
161+
\]
162+
163+
But also inline i.e \(z=x+y\)
164+
165+
\hypertarget{headings-third-level}{%
166+
\subsubsection{Headings: third level}\label{headings-third-level}}
167+
168+
Another paragraph.
169+
170+
\hypertarget{examples-of-citations-figures-tables-references}{%
171+
\section{Examples of citations, figures, tables,
172+
references}\label{examples-of-citations-figures-tables-references}}
173+
174+
\label{sec:others}
175+
176+
You can insert references. Here is some text (Kour and Saabne 2014b,
177+
2014a) and see Hadash et al. (2018).
178+
179+
The documentation for \verb+natbib+ may be found at
180+
181+
You can use custom blocks with LaTeX support from \textbf{rmarkdown} to
182+
create environment.
183+
184+
\begin{center}
185+
\url{http://mirrors.ctan.org/macros/latex/contrib/natbib/natnotes.pdf\%7D}
186+
187+
\end{center}
188+
189+
Of note is the command \verb+\citet+, which produces citations
190+
appropriate for use in inline text.
191+
192+
You can insert LaTeX environment directly too.
193+
194+
\begin{verbatim}
195+
\citet{hasselmo} investigated\dots
196+
\end{verbatim}
197+
198+
produces
199+
200+
\begin{quote}
201+
Hasselmo, et al.\ (1995) investigated\dots
202+
\end{quote}
203+
204+
\begin{center}
205+
\url{https://www.ctan.org/pkg/booktabs}
206+
\end{center}
207+
208+
\hypertarget{figures}{%
209+
\subsection{Figures}\label{figures}}
210+
211+
You can insert figure using LaTeX directly.
212+
213+
See Figure \ref{fig:fig1}. Here is how you add footnotes. {[}\^{}Sample
214+
of the first footnote.{]}
215+
216+
\begin{figure}
217+
\centering
218+
\fbox{\rule[-.5cm]{4cm}{4cm} \rule[-.5cm]{4cm}{0cm}}
219+
\caption{Sample figure caption.}
220+
\label{fig:fig1}
221+
\end{figure}
222+
223+
But you can also do that using R.
224+
225+
\begin{Shaded}
226+
\begin{Highlighting}[]
227+
\FunctionTok{plot}\NormalTok{(mtcars}\SpecialCharTok{$}\NormalTok{mpg)}
228+
\end{Highlighting}
229+
\end{Shaded}
230+
231+
\begin{figure}
232+
\centering
233+
\includegraphics{skeleton_files/figure-latex/fig2-1.pdf}
234+
\caption{Another sample figure}
235+
\end{figure}
236+
237+
You can use \textbf{bookdown} to allow references for Tables and
238+
Figures.
239+
240+
\hypertarget{tables}{%
241+
\subsection{Tables}\label{tables}}
242+
243+
Below we can see how to use tables.
244+
245+
See awesome Table\textasciitilde{}\ref{tab:table} which is written
246+
directly in LaTeX in source Rmd file.
247+
248+
\begin{table}
249+
\caption{Sample table title}
250+
\centering
251+
\begin{tabular}{lll}
252+
\toprule
253+
\multicolumn{2}{c}{Part} \\
254+
\cmidrule(r){1-2}
255+
Name & Description & Size ($\mu$m) \\
256+
\midrule
257+
Dendrite & Input terminal & $\sim$100 \\
258+
Axon & Output terminal & $\sim$10 \\
259+
Soma & Cell body & up to $10^6$ \\
260+
\bottomrule
261+
\end{tabular}
262+
\label{tab:table}
263+
\end{table}
264+
265+
You can also use R code for that.
266+
267+
\begin{Shaded}
268+
\begin{Highlighting}[]
269+
\NormalTok{knitr}\SpecialCharTok{::}\FunctionTok{kable}\NormalTok{(}\FunctionTok{head}\NormalTok{(mtcars), }\AttributeTok{caption =} \StringTok{"Head of mtcars table"}\NormalTok{)}
270+
\end{Highlighting}
271+
\end{Shaded}
272+
273+
\begin{longtable}[]{@{}lrrrrrrrrrrr@{}}
274+
\caption{Head of mtcars table}\tabularnewline
275+
\toprule
276+
& mpg & cyl & disp & hp & drat & wt & qsec & vs & am & gear & carb \\
277+
\midrule
278+
\endfirsthead
279+
\toprule
280+
& mpg & cyl & disp & hp & drat & wt & qsec & vs & am & gear & carb \\
281+
\midrule
282+
\endhead
283+
Mazda RX4 & 21.0 & 6 & 160 & 110 & 3.90 & 2.620 & 16.46 & 0 & 1 & 4 &
284+
4 \\
285+
Mazda RX4 Wag & 21.0 & 6 & 160 & 110 & 3.90 & 2.875 & 17.02 & 0 & 1 & 4
286+
& 4 \\
287+
Datsun 710 & 22.8 & 4 & 108 & 93 & 3.85 & 2.320 & 18.61 & 1 & 1 & 4 &
288+
1 \\
289+
Hornet 4 Drive & 21.4 & 6 & 258 & 110 & 3.08 & 3.215 & 19.44 & 1 & 0 & 3
290+
& 1 \\
291+
Hornet Sportabout & 18.7 & 8 & 360 & 175 & 3.15 & 3.440 & 17.02 & 0 & 0
292+
& 3 & 2 \\
293+
Valiant & 18.1 & 6 & 225 & 105 & 2.76 & 3.460 & 20.22 & 1 & 0 & 3 & 1 \\
294+
\bottomrule
295+
\end{longtable}
296+
297+
\hypertarget{lists}{%
298+
\subsection{Lists}\label{lists}}
299+
300+
\begin{itemize}
301+
\tightlist
302+
\item
303+
Item 1
304+
\item
305+
Item 2
306+
\item
307+
Item 3
308+
\end{itemize}
309+
310+
\hypertarget{refs}{}
311+
\begin{CSLReferences}{1}{0}
312+
\leavevmode\hypertarget{ref-hadash2018estimate}{}%
313+
Hadash, Guy, Einat Kermany, Boaz Carmeli, Ofer Lavi, George Kour, and
314+
Alon Jacovi. 2018. {``Estimate and Replace: A Novel Approach to
315+
Integrating Deep Neural Networks with Existing Applications.''}
316+
\emph{arXiv Preprint arXiv:1804.09028}.
317+
318+
\leavevmode\hypertarget{ref-kour2014fast}{}%
319+
Kour, George, and Raid Saabne. 2014a. {``Fast Classification of
320+
Handwritten on-Line Arabic Characters.''} In \emph{Soft Computing and
321+
Pattern Recognition (SoCPaR), 2014 6th International Conference of},
322+
312--18. IEEE.
323+
324+
\leavevmode\hypertarget{ref-kour2014real}{}%
325+
---------. 2014b. {``Real-Time Segmentation of on-Line Handwritten
326+
Arabic Script.''} In \emph{Frontiers in Handwriting Recognition (ICFHR),
327+
2014 14th International Conference on}, 417--22. IEEE.
328+
329+
\end{CSLReferences}
330+
331+
\bibliographystyle{unsrt}
332+
\bibliography{references.bib}
333+
334+
335+
\end{document}
Binary file not shown.

0 commit comments

Comments
 (0)