DidierMurilloF / FielDHub

FielDHub is an R Shiny design of experiments (DOE) app that aids in the creation of traditional, unreplicated, augmented and partially replicated (p-rep) designs applied to agriculture, plant breeding, forestry, animal and biological sciences.
https://didiermurillof.github.io/FielDHub/
Other
39 stars 20 forks source link

Authorship by function #7

Closed Prof-ThiagoOliveira closed 3 years ago

Prof-ThiagoOliveira commented 3 years ago

Dear authors,

Could you provide authorship for each function in the package rather than just in the description file? This is an important step to see how authors/contributors have contributed to this package's development. Please, remember that each contributor should appear in the description file. Sorry to be a little bit pedantic about it, but you will see this step is important over the next releases (years). When you describe contributors and authors only on the description file, I assumed they have contributed to all functions, which, probably, is not true.

Please, check the box when you have attributed authorship for the following functions:

Thanks.

tatirri commented 3 years ago

Dear Professor Thiago Oliveira, Thank you very much for reaching out to us regarding the authorship of these functions. The two main authors who wrote all these functions are Didier Murillo-Florez and Salvador Alejandro Gezan. We will take into account your recommendations and put their names in the formulas above. The other people included in the paper have contributed with ideas, patches, shiny development coding and field design theory and background related to agriculture/biology applications of the design of experiments.

Thanks for your time and all your contributions to this application and to the paper.

Have a wonderful rest of your day,

Ana Maria Heilman-Morales

Prof-ThiagoOliveira commented 3 years ago

Dear Ana Maria,

Thank you for your reply. Please note that people who contributed with some idea to the code should also be included as contributors to that function. So, you can distinguish them by attributing to each person a label such as [aut] for author or [ctb] for a contributor.

Have a wonderful rest of your day too!

DidierMurilloF commented 3 years ago

Dear Thiago,

I would like to ask you if this is the right way to implement your request. The following information will be in the R functions description.

' @author Didier Murillo [aut],

' Salvador Gezan [aut],

' Ana Heilman [ctb],

' Thomas Walk [ctb],

' Johan Aparicio [ctb],

' Richard Horsley [ctb]

Thank you!

Prof-ThiagoOliveira commented 3 years ago

Dear @DidierMurilloF,

Of course, you can differentiate types of contribution by function; however, it can be too informative. My suggestion here is to include names and email only. These are the most common ways I have been seen in R:

  1. Example 1:

    ' @author Didier Murillo, \email{your email}, Salvador Gezan, Ana Heilman, ...

  2. Example 2:

    ' @author Didier Murillo, \email{your email}, Salvador Gezan \email{email}, Ana Heilman \email{email}, ...

Perhaps, my suggestion above may have confounded you. Sorry about that.

DidierMurilloF commented 3 years ago

Dear Profesor Thiago,

I added the information for the authorship by function. Please, could you check it? Thank you!

Didier Murillo.

Prof-ThiagoOliveira commented 3 years ago

Done!