add open mind template #305

mikabr · 2020-08-04T21:41:09Z

To contribute a new article template to this package, please make sure you have done the following things (note that journalname_article below is only an example name):

Lastly, please try your best to do only one thing per pull request (e.g., if you want to add two output formats, do them in two separate pull requests), and refrain from making cosmetic changes in the code base: https://yihui.name/en/2018/02/bite-sized-pull-requests/

Thank you!

cderv

Thanks for your contribution !

I left a few comments below. General ones:

The content of the skeleton is rather simple. You did not use any citation for example, that means the format is not tested with the bib. I don't think it is working currently. Can you check that ? You may need to use natbib citation package and not the default pandoc... 🤔
If you wish, you can take some example of OpenMindSample.tex to add them in the Rmd to show some content for examples. the sample file provided by OpenMind is rather exhaustive! Could be worth it. Unless each user is well aware of how it works.

Don't mind the potential git conflict, I'll deal with them later.

cderv · 2020-08-10T10:20:57Z

inst/rmarkdown/templates/opmi_article/resources/template.tex

+\authorcontributions
+$author_contributions$
+
+\bibliography{$biblio$}


The variable provided in yaml is bibliography. I think it should be $bibliography$ here - currently, it is empty, in the resulting tex file

cderv · 2020-08-10T10:28:24Z

inst/rmarkdown/templates/opmi_article/resources/template.tex

+$author_contributions$
+
+\bibliography{$biblio$}
+


There is an optionnal appendix in the OpenMindTemplate.Tex file and in your yaml header in skeleton.Rmd. Should it be here ?

cderv · 2020-08-10T10:32:20Z

inst/rmarkdown/templates/opmi_article/skeleton/skeleton.Rmd

+appendix: |
+ Optional appendix
+ \section{Sample appendix section}


There is no appendix variable in your template.tex for this. I think it should be added.

cderv · 2020-08-10T10:39:41Z

inst/rmarkdown/templates/opmi_article/skeleton/skeleton.Rmd

+Text here. Text here. Text here. Text here.
+
+
+# References


This will be added at the end of the body so right before \section{Supportive Information} and not before the bibliography.

The OpenMindSample.tex does not seem to have this header, however it has the result have it.

CLAassistant · 2020-09-24T18:34:20Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ cderv
❌ mikabr
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

cderv · 2021-06-09T13:21:25Z

Hi @mikabr,

do you plan to keep on working on this following the review ?

Just trying to know the status of this PR.

thanks!

mikabr · 2021-06-23T04:11:09Z

@cderv really sorry for the delay, it's been on my backburner for a while but I'd still like to complete it if that would be possible

cderv · 2021-06-23T08:03:25Z

@mikabr Thanks for getting back to me! Sure that would be possible. Really no issue to take your time on this, I just wanted to know if it still was in your scope 😉

Things could move in the meantime so you'll need to deal with merge conflict to solve but nothing to impactful I believe. Ask me if you need anything.

And ping me when you are ready for a final review.

cderv

Hey,

As it is already an old PR, I have updated it to merge master branch into this. This will allow you to start on correct ground when you'll finish the work on this one.

The comments above marked as outdated are still valid by the way. It is just that the file has moved.

cderv · 2021-11-29T13:50:14Z

NEWS.md

@@ -6,6 +6,8 @@

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

+- Added OpenMind template (@mikabr)


Suggested change

- Added OpenMind template (@mikabr)

- Added OpenMind template (thanks, @mikabr, #305).

cderv · 2021-11-29T13:51:04Z

R/article.R

+#' @section `opmi_article`: Format for creating Open Mind articles. Adapted from
+#' \url{https://www.mitpressjournals.org/journals/opmi/sub}.


Suggested change

#' @section `opmi_article`: Format for creating Open Mind articles. Adapted from

#' \url{https://www.mitpressjournals.org/journals/opmi/sub}.

#' @section `opmi_article`: Format for creating Open Mind articles. Adapted from

#' <https://www.mitpressjournals.org/journals/opmi/sub>.

We can use markdown syntax in roxygen now

cderv · 2021-11-29T13:54:08Z

inst/rmarkdown/templates/opmi/resources/template.tex

@@ -0,0 +1,85 @@
+\documentclass[$class_option$]{stjour}
+
+$if(journal_name)$\journalname{$journal_name$}$endif$


We usually don't use _ in variable. Rather - if needed as other Pandoc variables (https://pandoc.org/MANUAL.html#variables)

cderv · 2021-11-29T13:55:54Z

inst/rmarkdown/templates/opmi/resources/template.tex

@@ -0,0 +1,85 @@
+\documentclass[$class_option$]{stjour}


The usual variable should be used, with a for loop in case of several option. See example in other format:

rticles/inst/rmarkdown/templates/tf/resources/template.tex

Line 4 in e553097

\documentclass[$for(classoption)$$classoption$$sep$,$endfor$]{interact}

cderv · 2021-11-29T13:56:15Z

inst/rmarkdown/templates/opmi/resources/template.tex

+\title[$short_title$]{$title$}
+$if(subtitle)$
+\subtitle{$subtitle$}
+$endif$
+
+\author[$short_author$]{
+ $for(author)$
+ $author.name$\affil{$author.affiliation$}$sep$,
+ $endfor$
+}


Regarding variable name, we should try to use common values

example:

rticles/inst/rmarkdown/templates/glossa/resources/template.tex

Line 49 in 03b308e

\author[$if(shortauthors)$$shortauthors$$endif$]{

Related to #411

cderv · 2021-11-29T13:59:06Z

R/article.R

+opmi_article <- function(..., keep_tex = TRUE) {
+ pdf_document_format("opmi", keep_tex = keep_tex, ...)
+}


Does this format needs to be used with a citation package specifically ? like natbib ?
If so, it needs to be set in there.

If it can be used with the default Pandoc citeproc that is great. Only the template would need adjustment.

cderv · 2021-11-29T13:59:23Z

inst/rmarkdown/templates/opmi/resources/template.tex

+$for(header-includes)$
+$header-includes$
+$endfor$
+


We need to add other content for Pandoc. Please see other template

Example: https://github.com/rstudio/rticles/pull/427/files#r678334426

cderv · 2023-04-19T11:01:57Z

👋 @mikabr - Just getting back on this for update on the status.

but I'd still like to complete it if that would be possible

Is this still a project you want to finish ?

mikabr · 2023-04-29T18:43:58Z

👋 @mikabr - Just getting back on this for update on the status.

but I'd still like to complete it if that would be possible

Is this still a project you want to finish ?

given that I haven't gotten to it in a year and a half, I think it's unlikely to happen

cderv · 2023-05-02T08:53:50Z

OK I'll se if / when I can get to it then. thanks

add open mind template

7c5d718

mikabr mentioned this pull request Aug 4, 2020

Add OpenMind article template #194

Closed

yihui requested a review from cderv August 6, 2020 14:45

cderv self-assigned this Aug 6, 2020

cderv requested changes Aug 10, 2020

View reviewed changes

Merge branch 'master' into mikabr-master

d5f9673

cderv requested changes Nov 29, 2021

View reviewed changes

cderv removed their assignment Apr 19, 2023

cderv added the WIP label Apr 19, 2023

cderv marked this pull request as draft May 2, 2023 08:53

cderv added the help wanted ❤️ we'd love your help! label May 2, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add open mind template #305

add open mind template #305

mikabr commented Aug 4, 2020 •

edited

cderv left a comment •

edited

cderv Aug 10, 2020

cderv Aug 10, 2020

cderv Aug 10, 2020

cderv Aug 10, 2020

CLAassistant commented Sep 24, 2020 •

edited

cderv commented Jun 9, 2021

mikabr commented Jun 23, 2021

cderv commented Jun 23, 2021 •

edited

cderv left a comment •

edited

cderv Nov 29, 2021

cderv Nov 29, 2021

cderv Nov 29, 2021

cderv Nov 29, 2021

cderv Nov 29, 2021

cderv Nov 29, 2021

cderv Nov 29, 2021

cderv commented Apr 19, 2023

mikabr commented Apr 29, 2023

cderv commented May 2, 2023

		@@ -6,6 +6,8 @@

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

		- Added OpenMind template (@mikabr)

	- Added OpenMind template (@mikabr)
	- Added OpenMind template (thanks, @mikabr, #305).

		#' @section `opmi_article`: Format for creating Open Mind articles. Adapted from
		#' \url{https://www.mitpressjournals.org/journals/opmi/sub}.

		@@ -0,0 +1,85 @@
		\documentclass[$class_option$]{stjour}

		$if(journal_name)$\journalname{$journal_name$}$endif$

		$author_contributions$

		\bibliography{$biblio$}

add open mind template #305

Are you sure you want to change the base?

add open mind template #305

Conversation

mikabr commented Aug 4, 2020 • edited

cderv left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CLAassistant commented Sep 24, 2020 • edited

cderv commented Jun 9, 2021

mikabr commented Jun 23, 2021

cderv commented Jun 23, 2021 • edited

cderv left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cderv commented Apr 19, 2023

mikabr commented Apr 29, 2023

cderv commented May 2, 2023

mikabr commented Aug 4, 2020 •

edited

cderv left a comment •

edited

CLAassistant commented Sep 24, 2020 •

edited

cderv commented Jun 23, 2021 •

edited

cderv left a comment •

edited