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

ieee_article() add journal support #375

Open
wants to merge 32 commits into
base: main
Choose a base branch
from

Conversation

Karel-Kroeze
Copy link

Added support for IEEE journals (so far it only supported conference papers). This is primarily visible in the author/affiliations, and some minor other tweaks to the front page (e.g. , instead of ; in the keyword list).

I've also added ieee.csl and enabled it by default so that pandoc-style (@cite) citations are a viable alternative to the latex-style citations (\cite) that are currently enforced. Latex style citations should still work as before for those that desire them.

Note that there are a lot of IEEE flavours for its various journals, providing a one-size-fits-all template might be more trouble than it's worth.

@CLAassistant

This comment was marked as outdated.

Copy link
Collaborator

@cderv cderv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution. I am not quite familiar with the IEEE format so I trust you on this.

I left a few comments. I think we mainly need to document better in the skeleton file maybe the difference between the two formats.

  • Is there any other format than journal and conference ?
  • I am not quite sure to see the difference in the author field. How should it be modified for conference ?
  • Should the skeleton be journal first as you changed or conference first ?

Pinging other IEEE contributor if they have some thoughts on all this : 👋 @Emaasit, @espinielli, @nathanweeks, @DunLug

And please merge the current main so that the new CI workflow is triggered and we check this works ok.
Also, can you sign the CLA ?

Thanks !

inst/rmarkdown/templates/ieee/resources/template.tex Outdated Show resolved Hide resolved
DESCRIPTION Outdated Show resolved Hide resolved
inst/rmarkdown/templates/ieee/resources/template.tex Outdated Show resolved Hide resolved
inst/rmarkdown/templates/ieee/skeleton/skeleton.Rmd Outdated Show resolved Hide resolved
inst/rmarkdown/templates/ieee/skeleton/skeleton.Rmd Outdated Show resolved Hide resolved
NEWS.md Outdated Show resolved Hide resolved
inst/rmarkdown/templates/ieee/skeleton/skeleton.Rmd Outdated Show resolved Hide resolved
R/ieee_article.R Outdated Show resolved Hide resolved
@Karel-Kroeze
Copy link
Author

Hi @cderv,

Thank you for taking the time for the thorough review. As you may have noticed I have little experience with pandoc and the innards of rticles, but I've learned quite a few new things from your comments alone.

As for this PR. Honestly, my experience with IEEE requirements has been a nightmare. This template will not work with all journals, because many have exceptions to the 'main' IEEE template. The author guidelines are often confusing or plain self-contradictory. I crafted this template to fit the guidelines for IEEE transactions on Learning Technology, but still received comments on several deviations (I can't recall the details at the moment).

I'm not sure that a single template is ever going to be able to fit all IEEE journals, and any attempt is likely to be so full of special cases that it will be difficult to write, let alone maintain. IEEE covers a wide range of journals and conferences, and I do not have enough experience to make any statements about which is more common, or if the differences between journal guidelines are more structured than I perceived. If the template as it is works for conference papers, I would honestly suggest keeping it that way. In either case, I would urge waiting for reviews by the other contributors to this template.

Personally, I fell back on manually editing a Word (😱) render of my manuscript and the template provided by the journal, rather than trying to integrate IEEE's boutique set of latex dependencies into my bookdown and rticles workflow.

@cderv
Copy link
Collaborator

cderv commented Jun 21, 2021

Thanks for the feedback !

From reading you ☝️, this makes me think that we could also provide a template for each journal. Something closer to other formats and THE ieee template but maybe one per journal. This would be something like ieee_article(journal="TLT") that would use a template for IEEE Transaction on Learning Technology that is known to have work. What do you think ?

Unless you really think this would still lead to a lot of editor feedbacks and it will be hard to help comply with rticle template.

We'll see if we'll have feedback from past contributors - it is possible we don't 😅

Also,

As you may have noticed I have little experience with pandoc and the innards of rticles, but I've learned quite a few new things from your comments alone.

Everyone starts with a few knowledge, but it surely grows with practice and contributing PR is one of them. We really appreciate contributing PR !! Thanks again.

@cderv cderv self-assigned this Sep 7, 2021
Copy link
Collaborator

@cderv cderv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Karel-Kroeze I take care of finishing the PR. This is now ready to merge.
Thanks a lot for your initial work and your answer on the review.

Last step before merging is for you to sign the CLA if you don't mind. We currently need that for substantial contribution as yours here.
You can do it using the CLAassistant at this link: https://cla-assistant.io/check/rstudio/rticles?pullRequest=375

Otherwise, you can also do it by email: See details in CONTRIBUTING GUIDE

Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants