Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GigaScience rticle support #156

Open
wants to merge 21 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
dff0255
initially add support for GigaScience; not yet thorooughly tested; st…
eschen42 Feb 18, 2018
1dd47b8
expose more configuration to through the skeleton file header
eschen42 Feb 18, 2018
c08d44a
initial implementation complete
eschen42 Feb 20, 2018
d1bdef6
added man/gigascience_article.Rd generated by devtools::document
eschen42 Feb 20, 2018
d5a50ff
improved citet and citep explanations
eschen42 Feb 20, 2018
b020923
added tlmgr_pkg to assist setup of TexLive prior to running GigaScien…
eschen42 Feb 20, 2018
63d1438
added tlmgr_local script to install required TeX*Live packages to sup…
eschen42 Feb 22, 2018
78cb880
corrected per yihui's instructions from 2 July 2018
eschen42 Jul 22, 2018
1b109f6
merge upstream master
eschen42 Jul 23, 2018
bcbf202
devtools::test() passes after 'mkdir tests/testthat; cd tests/testtha…
eschen42 Jul 23, 2018
6604452
modifications for pull request
eschen42 Jul 29, 2018
665ea85
Merge branch 'master' into gigascience
eschen42 Nov 17, 2020
d4e6f26
Merge branch 'master' into eschen42-gigascience
cderv Nov 30, 2021
0b6856f
Use new way to create the format
cderv Nov 30, 2021
802c8db
Store function with the others
cderv Nov 30, 2021
58badb1
Merge branch 'main' into eschen42-gigascience
cderv May 5, 2023
701e1c1
Align author in DESCRIPTION
cderv May 5, 2023
b05ec78
keep new lines
cderv May 5, 2023
c558975
Missing colon in DESCRIPTION
cderv May 5, 2023
0589cb8
Merge branch 'main' into eschen42-gigascience
cderv May 5, 2023
e0d0c11
Add missing part for Pandoc in templates and reorganize order
cderv May 5, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: rticles
Type: Package
Title: Article Formats for R Markdown
Version: 0.4.2.9000
Version: 0.4.2.9001
Authors@R: c(
person("JJ", "Allaire", role = c("aut", "cre"), email = "[email protected]"),
person(family = "R Foundation", role = c("aut", "cph")),
Expand All @@ -25,7 +25,9 @@ Authors@R: c(
person("Thierry", "Onkelinx", role = c("aut", "cph"), email = "[email protected]"),
person("Marc-Andre", "Desautels", role = c("aut", "cph"), email = "[email protected]"),
person("Dominik", "Leutnant", role = c("aut", "cph"), email = "[email protected]"),
person(family = "MDPI", role = c("aut", "cph"))
person(family = "MDPI", role = c("aut", "cph")),
person("Arthur", "Eschenlauer", role = c("aut", "cph"), email = "[email protected]"),
person(family = "GigaScience", role = c("aut", "cph"))
)
Description: A suite of custom R Markdown formats and templates for
authoring journal articles and conference submissions.
Expand Down
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ export(asa_article)
export(ctex)
export(ctex_template)
export(elsevier_article)
export(gigascience_article)
export(ieee_article)
export(jss_article)
export(mdpi_article)
Expand Down
27 changes: 27 additions & 0 deletions R/gigascience_article.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
#' GigaScience journal format.
#'
#' Format for creating submissions to the GigaScience journal. Adapted from GigaScience Overleaf template
#' \href{https://www.overleaf.com/latex/templates/template-for-gigascience-journal-manuscript-submissions/shgtrssvbjhs}{https://www.overleaf.com/latex/templates/template-for-gigascience-journal-manuscript-submissions/shgtrssvbjhs}.
#'
#' @inheritParams rmarkdown::pdf_document
#' @param ... Additional arguments to \code{rmarkdown::pdf_document}
#'
#' @return R Markdown output format to pass to
#' \code{\link[rmarkdown:render]{render}}
#'
#' @examples
#'
#' \dontrun{
#' library(rmarkdown)
#' draft("MyArticle.Rmd", template = "gigascience_article", package = "rticles")
#' }
#'
#' @export
gigascience_article <- function(...,
keep_tex = TRUE,
md_extensions = c("-autolink_bare_uris")) {
inherit_pdf_document(...,
template = find_resource("gigascience_article", "template.tex"),
keep_tex = keep_tex,
md_extensions = md_extensions)
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Please note that whilst this template provides a
% preview of the typeset manuscript for submission, it
% will not necessarily be the final publication layout.
%
\documentclass[$paper$,$reftype$]{$document-class$}

% declare highlighting-macros if any
$if(highlighting-macros)$
$highlighting-macros$
$endif$

% include header-includes if any
$for(header-includes)$
$header-includes$
$endfor$

% before include preamble if any
$preamble$
% after include preamble if any

%%% declare packages to be used
\usepackage{forarray}
\usepackage{xstring}
\usepackage{graphicx}
\usepackage{siunitx}

%%% unpackged commands
\providecommand{\tightlist}{%
\setlength{\itemsep}{0pt}\setlength{\parskip}{0pt}}


%%% Flushend: You can add this package to automatically balance the final page, but if things go awry (e.g. section contents appearing out-of-order or entire blocks or paragraphs are coloured), remove it!
% \usepackage{flushend}



\title{$title$}

%%% Authors
$for(author)$ \author[$for(author.affiliation)$$author.affiliation$$sep$,$endfor$$for(author.note)$,\authfn{$author.note$}$endfor$]{$author.name$} $sep$
$endfor$

%%% Author Affiliations
$for(affiliation)$ \affil[$affiliation.id$]{$affiliation.name$$if(affiliation.address)$, $affiliation.address$$endif$}
$endfor$

%%% Use the \authfn to add symbols for additional footnotes, if any. 1 is reserved for correspondence emails; then continuing with 2 etc for contributions.
%%% Author Notes
$for(authnote)$\authnote{\authfn{$authnote.id$}$authnote.note$}$sep$
$endfor$


%%% Paper category
\papercat{$papercat$}

%%% "Short" author for running page header
\runningauthor{$runningauthor$}

%%% Should only be set by an editor
\jvolume{00}
\jnumber{0}
\jyear{2018}

\begin{document}
\begin{frontmatter}
\maketitle
\begin{abstract}
$abstract$
\end{abstract}

\begin{keywords}
$for(keywords)$$keywords$$sep$; $endfor$
\end{keywords}
\end{frontmatter}

\begin{keypoints*}
\begin{itemize}
$for(keypoints)$\item{$keypoints$}$sep$
$endfor$
\end{itemize}
\end{keypoints*}

$body$

%%% The document ends here
\end{document}
Binary file not shown.
Loading