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

starting to add jors #397

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
3 changes: 2 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ Authors@R: c(
person("Greg", "Macfarlane", role = c("ctb"), email = "[email protected]", comment = c(github = "gregmacfarlane")),
person("Matthias", "Templ", role = c("ctb"), email = "[email protected]", comment = c(ORCID = "0000-0002-8638-5276", github = "matthias-da")),
person("Alvaro", "Uzaheta", role = c("ctb"), email = "[email protected]", comment = c(github = "auzaheta")),
person("JooYoung", "Seo", role=c("ctb"), email="[email protected]", comment = c(ORCID = "0000-0002-4064-6012"))
person("JooYoung", "Seo", role=c("ctb"), email="[email protected]", comment = c(ORCID = "0000-0002-4064-6012")),
person("Gregory A.", "Pilgrim", role = c("ctb"), email = "[email protected]", comment = c(github = "gpligrim2670", ORCID = "0000-0001-7831-442X"))
)
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 @@ -22,6 +22,7 @@ export(ieee_article)
export(ims_article)
export(jasa_article)
export(jedm_article)
export(jors_article)
export(joss_article)
export(journals)
export(jss_article)
Expand Down
2 changes: 2 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

- Add `trb_article()` for annual meeting submissions to the Transportation Research Board Annual Meeting (thanks, @gregmacfarlane, #427).

- Add article template `jors_article()` for *Journal of Open Research Software* (JORS) (thanks, @gpilgrim2670, #397).

# rticles 0.21

## NEW FEATURES
Expand Down
14 changes: 14 additions & 0 deletions R/article.R
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,20 @@ jasa_article <- function(
)
}

#' @section `jors_article`: Format for creating submissions to the
#' Journal of Open Research Software. Adapted from
#' <https://openresearchsoftware.metajnl.com/about/submissions/>
#' @export
#' @rdname article
jors_article <- function(
..., keep_tex = TRUE, latex_engine = "xelatex", citation_package = "natbib"
) {
pdf_document_format(
"jors", keep_tex = keep_tex, latex_engine = latex_engine,
citation_package = citation_package, ...
)
}

#' @section `lipics_article`: Format for creating submissions to
#' LIPIcs - Leibniz International Proceedings Informatics - articles.
#' Adapted from the official Instructions for Authors at
Expand Down
3 changes: 2 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ Currently included templates and their contributors are the following:
| [IEEE Transaction](http://www.ieee.org/publications_standards/publications/authors/author_templates.html) | [\@Emaasit](https://github.com/Emaasit), [\@espinielli](https://github.com/espinielli), [\@nathanweeks](https://github.com/nathanweeks), [\@DunLug](https://github.com/DunLug) | [\#97](https://github.com/rstudio/rticles/pull/97), [\#169](https://github.com/rstudio/rticles/pull/169), [\#227](https://github.com/rstudio/rticles/pull/227), [\#263](https://github.com/rstudio/rticles/pull/263), [\#264](https://github.com/rstudio/rticles/pull/264), [\#265](https://github.com/rstudio/rticles/pull/265) | `ieee_article()` |
| [IMS: Institute of Mathematical Statistics](https://imstat.org/) [AoAS: Annals of Applied Statistics](https://imstat.org/journals-and-publications/annals-of-applied-statistics/) | [\@auzaheta](https://github.com/auzaheta)| [\#372](https://github.com/rstudio/rticles/pull/372) | `ims_article()`|
| [JASA: Journal of the Acoustical Society of America](https://asa.scitation.org/journal/jas) | [\@stefanocoretta](https://github.com/stefanocoretta)| [\#364](https://github.com/rstudio/rticles/pull/364) | `jasa_article()` |
| [Journal of Educational Data Mining](https://jedm.educationaldatamining.org/index.php/JEDM/about/submissions) journal submissions | [\@jooyoungseo](https://github.com/jooyoungseo) | [#251](https://github.com/rstudio/rticles/pull/251) | `jedm_article()` |
| [Journal of Educational Data Mining](https://jedm.educationaldatamining.org/index.php/JEDM/about/submissions) journal submissions | [\@jooyoungseo](https://github.com/jooyoungseo) | [\#251](https://github.com/rstudio/rticles/pull/251) | `jedm_article()` |
| [JORS: Journal of Open Research Software](https://openresearchsoftware.metajnl.com/) | [@gpilgrim2670](https://github.com/gpilgrim2670) | [\#397](https://github.com/rstudio/rticles/pull/397) | `jors_article()` |
| [JOSS: Journal of Open Source Software](https://joss.theoj.org/) [JOSE: Journal of Open Source Education](https://jose.theoj.org/)| [\@noamross](https://github.com/noamross)| [\#229](https://github.com/rstudio/rticles/pull/229) | `joss_article()` |
| [JSS: Journal of Statistical Software](https://www.jstatsoft.org) ||| `jss_article()`|
| [LIPIcs](https://www.dagstuhl.de/en/publications/lipics)| [\@nuest](https://github.com/nuest)| [\#288](https://github.com/rstudio/rticles/pull/288) | `lipics_article()` |
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ Currently included templates and their contributors are the following:
| [IMS: Institute of Mathematical Statistics](https://imstat.org/) [AoAS: Annals of Applied Statistics](https://imstat.org/journals-and-publications/annals-of-applied-statistics/) | [@auzaheta](https://github.com/auzaheta) | [#372](https://github.com/rstudio/rticles/pull/372) | `ims_article()` |
| [JASA: Journal of the Acoustical Society of America](https://asa.scitation.org/journal/jas) | [@stefanocoretta](https://github.com/stefanocoretta) | [#364](https://github.com/rstudio/rticles/pull/364) | `jasa_article()` |
| [Journal of Educational Data Mining](https://jedm.educationaldatamining.org/index.php/JEDM/about/submissions) journal submissions | [@jooyoungseo](https://github.com/jooyoungseo) | [#251](https://github.com/rstudio/rticles/pull/251) | `jedm_article()` |
| [JORS: Journal of Open Research Software](https://openresearchsoftware.metajnl.com/) | [@gpilgrim2670](https://github.com/gpilgrim2670) | [#397](https://github.com/rstudio/rticles/pull/397) | `jors_article()` |
| [JOSS: Journal of Open Source Software](https://joss.theoj.org/) [JOSE: Journal of Open Source Education](https://jose.theoj.org/) | [@noamross](https://github.com/noamross) | [#229](https://github.com/rstudio/rticles/pull/229) | `joss_article()` |
| [JSS: Journal of Statistical Software](https://www.jstatsoft.org) | | | `jss_article()` |
| [LIPIcs](https://www.dagstuhl.de/en/publications/lipics) | [@nuest](https://github.com/nuest) | [#288](https://github.com/rstudio/rticles/pull/288) | `lipics_article()` |
Expand Down
55 changes: 55 additions & 0 deletions inst/rmarkdown/templates/jors/resources/template.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
%% Journal of Open Research Software RMD Latex template -- Created by Greg Pilgrim based on a previous template by Stephen Bonner and John Brennan, Durham Universtiy, UK

\documentclass{jors}

%% Set the header information
\pagestyle{fancy}
\definecolor{mygray}{gray}{0.6}
\renewcommand\headrule{}
\rhead{\footnotesize 3}
\rhead{\textcolor{gray}{UP JORS software RMD paper template version 0.1}}
\setlength{\headheight}{14.5pt}
\fancyhead[L, C]{} % this prevents natbib from adding "References" to the L header after references section. Also blanks C header becuase nothing should be there.

%% definitions
\def\tightlist{}

% bibliography package - want a numbered in-text citation
\usepackage[numbers]{natbib} % bibliography package

% Enable the 'Shaded' regions used in figures and code chunks
\usepackage{graphicx}
$if(highlighting-macros)$
$highlighting-macros$
$endif$

%% Body of article

\begin{document}

{\bf Software paper for submission to the Journal of Open Research Software}

$body$

\vspace{2cm}

\rule{\textwidth}{1pt}

\bibliographystyle{jors}
\bibliography{$bibliography$}


\vspace{2cm}

\rule{\textwidth}{1pt}

{ \bf Copyright Notice} \\
Authors who publish with this journal agree to the following terms: \\

Authors retain copyright and grant the journal right of first publication with the work simultaneously licensed under a \href{http://creativecommons.org/licenses/by/3.0/}{Creative Commons Attribution License} that allows others to share the work with an acknowledgement of the work's authorship and initial publication in this journal. \\

Authors are able to enter into separate, additional contractual arrangements for the non-exclusive distribution of the journal's published version of the work (e.g., post it to an institutional repository or publish it in a book), with an acknowledgement of its initial publication in this journal. \\

By submitting this paper you agree to the terms of this Copyright Notice, which will apply to this submission if and when it is published by this journal

\end{document}
Loading