ClaudioZandonella / trackdown

R package for collaborative writing and editing of R Markdown (or Sweave) documents in Google Docs.
https://ClaudioZandonella.github.io/trackdown/
GNU General Public License v3.0
214 stars 15 forks source link

UseR2021 #8

Closed ClaudioZandonella closed 3 years ago

ClaudioZandonella commented 3 years ago

Dear all (@ekothe, @januz, @filippogambarota, @Lingtax )

I created a folder in Google Drive with a single file Abstract-submission to review the submission at the UseR2021 conference. Here is the link to contribute https://drive.google.com/drive/folders/1goMOIiGZ7y-N3Fokrq65kAUpVKSxis94?usp=sharing. In the first part of the document I copied relevant info for the submission, then I prepared a first draft of the abstract and other required info.

You can change, add, review and comment.

Important missing info:

Moreover, is there anyone talented in video presentations who would like to be the presenting and first author?

Submission deadline 15th March

So it would be great to submit everything in the next few days, say by Friday 12th March.

januz commented 3 years ago

@ClaudioZandonella Thanks for preparing the submission. With regards to your questions

package name

I think we're getting close to making a decision here. As far as I understand our discussions in the other thread, we want to ingrate the package in the ...down family and want the name to describe the process the package will be used in. Our ideas so far are:

Of these, I like trackdown the best as it represents the track changes function and also sounds good because it's an English phrase ("track down {something}")

Github repo

I think that using @ekothe's original repo would be great as it would make it easiest to backtrace the evolution the package has gone through (including our discussions here).

Authorship and useR presentation

From my point of view, as @ClaudioZandonella and @filippogambarota had the initiative to take on this bigger rewrite, they should be leading the author list and the presentation / future publications, etc. One can also make the argument that @ekothe should be first author for the initial package idea and implementation. But maybe last authorship would represent this contribution adequately? I'm fine with being somewhere in the middle as I am contributing to but not leading the efforts.

Lingtax commented 3 years ago

As previous, I like trackdown, and I think Ben did also. Putting it in the original repo makes the most sense to me too.

ClaudioZandonella commented 3 years ago

Perfect, I like trackdown. If everyone agrees we have a name!

I have already added the name to the submission document. Now I would ask @ekothe to rename the repository, please. We could leave everything untouched in the main branch and only update the readme file explaining that the package is undergoing a major revision (with a new name as well).

Then if it is ok to @ekothe you could add us as collaborators in the repository. I would open a new branch and copy the version of the package under revision.

Considering the UseR2021 submission, we need the full name and affiliation of all authors (just check the data I provided if it is correct and add missing information).

Regarding the first author that would be the presenter, I just would like to know if there is a volunteer. I am sure @filippogambarota would be willing to do the presentation (he is a great presenter) but I don't know if anyone else would like to present as well. We can decide.

You can also revise the submission (title; abstract; keywords; topic).

I will send everything by the end of the week. Thanks!

ekothe commented 3 years ago

+1 for trackdown.

I've got a busy few days of teaching - so instead of renaming the the package and then adding you all would it be ok if I added everyone and then someone else can take charge of the package rename etc?

Based on past experience, "global online" conferences rarely have presentation times that are particularly Australian timezone friendly - so if there is someone else who is happy to present I'm happy to not have to manage a middle of the night presentation πŸ˜€

Lingtax commented 3 years ago

I'm happy to take the renaming bullet for you, Emily.

Lingtax commented 3 years ago

All good, time to pull in the features from your forks 😁

januz commented 3 years ago

Thanks, @Lingtax!

@ClaudioZandonella As far as I understand your fork is based on my fork, correct? So I assume you will just add yours and @filippogambarota's code and there's nothing that I should add here?

ClaudioZandonella commented 3 years ago

Dear @januz,

after an acrobatic series of marges, updates, conflicts, and other git wonderful stuff, I have added all the code in the develop branch. Now all commits history should be available. In the next week I will finish developing the last few things so, once reached a stable point, we can review everything together...

There is only one thing that does not work properly. Github action evaluating test coverage runs correctly but is not able to upload the report to codecov, so we miss the badge with the percentage.

I do not understand. Maybe is something related to the rename of the repository as it says "Could not find a repository, try using upload token". Could you please (@ekothe or @Lingtax ) try to follow these instructions at https://docs.codecov.io/docs/quick-start#basic-usage check if the repo ekothe/trackdown is available and in case send me by email (claudiozandonella@gmail.com) the secret token as shown in the figure?

It is strange as for public repo token is not required, but something is not working properly.

ClaudioZandonella commented 3 years ago

Dear all (@ekothe, @januz, @Lingtax, @filippogambarota ),

Sorry to bother you during the weekend. I want to thank everyone for their contribution and suggestions to the submission. I revised the final version of the abstract, unfortunately, I had to cut some parts to abide by the 250 words limit. I am really happy with the final results and there are lots of good points we can use in the presentation.

I copy everything here as a small recap and tomorrow I will submit it.

Title - trackdown: collaborative writing and editing your R Markdown and Sweave documents in Google Drive Primary Topic - Reproducibility Keywords - document-editing; reproducibility; rmarkdown; sweave; collaborative-writing

Abstract [250/250 words - edited] The advantages of using literate programming that combines plain-text and code chunks (e.g., R Markdown and Sweave) are well recognized. This allows creation of rich, high quality, and reproducible documents. However, collaborative writing and editing have always been a bottleneck. Distributed version control systems like git are recommended for collaborative code editing but far from ideal when working with prose. In the latter cases, other software (e.g, Microsoft Word or Google Docs) offer a more fluent experience, tracking document changes in a simple and intuitive way. When you further consider that collaborators often do not have the same level of programming competence, there does not appear to be an optimal collaborative workflow for writing reproducible documents. trackdown (formerly rmdrive) overcomes this issue by offering a simple solution to collaborative writing and editing of reproducible documents. Using trackdown, the local R Markdown or Sweave document is uploaded as plain-text in Google Drive allowing other colleagues to contribute to the prose using convenient features like tracking changes and comments. After integrating all authors’ contributions, the edited document is downloaded and rendered locally. This smooth workflow allows taking advantage of the easily readable Markdown and LaTeX plain-text combined with the optimal and well-known text editing experience offered by Google Docs. In this contribution, we will present the package and its main features. trackdown aims to promote good scientific practices that enhance overall work quality and reproducibility allowing also collaborators with no or limited R knowledge to contribute to literate programming workflows.

Finally regarding authors I would follow @januz suggestion If all you are agree:

  1. @filippogambarota
  2. @ClaudioZandonella
  3. @januz
  4. @Lingtax
  5. @ekothe

If you prefer another order just let me know I am happy with everything (even a random sample in R πŸ˜‰), or for any other change/edit/correction post here or directly in the Google Doc.

januz commented 3 years ago

@ClaudioZandonella This all sounds good to me. Thank you so much for integrating everything and for submitting to useR!

Lingtax commented 3 years ago

Looks great to me. The only suggestion I might offer is that spend the 2 remaining words to insert "(formerly rmdrive)" after the first reference to trackdown. It does have some existing reputation after all. Thanks all!


From: januz @.> Sent: Sunday, March 14, 2021 1:31:25 AM To: ekothe/trackdown @.> Cc: Mathew Ling @.>; Mention @.> Subject: Re: [ekothe/trackdown] UseR2021 (#8)

@ClaudioZandonellahttps://github.com/ClaudioZandonella This all sounds good to me. Thank you so much for integrating everything and for submitting to useR!

β€” You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://github.com/ekothe/trackdown/issues/8#issuecomment-798446760, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ADJYMJFOUXHLSQPMAJQ2H3TTDNSK3ANCNFSM4YZFHIEA.

Important Notice: The contents of this email are intended solely for the named addressee and are confidential; any unauthorised use, reproduction or storage of the contents is expressly prohibited. If you have received this email in error, please delete it and any attachments immediately and advise the sender by return email or telephone.

Deakin University does not warrant that this email and any attachments are error or virus free.

filippogambarota commented 3 years ago

Abstract submitted! :) there is a recap of the submission on the google drive folder! for any mistakes or typo we can still modify the submission!

On Sat, 13 Mar 2021 at 23:31, Mathew Ling @.***> wrote:

Looks great to me. The only suggestion I might offer is that spend the 2 remaining words to insert "(formerly rmdrive)" after the first reference to trackdown. It does have some existing reputation after all. Thanks all!


From: januz @.> Sent: Sunday, March 14, 2021 1:31:25 AM To: ekothe/trackdown @.> Cc: Mathew Ling @.>; Mention @.> Subject: Re: [ekothe/trackdown] UseR2021 (#8)

@ClaudioZandonellahttps://github.com/ClaudioZandonella This all sounds good to me. Thank you so much for integrating everything and for submitting to useR!

β€” You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub< https://github.com/ekothe/trackdown/issues/8#issuecomment-798446760>, or unsubscribe< https://github.com/notifications/unsubscribe-auth/ADJYMJFOUXHLSQPMAJQ2H3TTDNSK3ANCNFSM4YZFHIEA

.

Important Notice: The contents of this email are intended solely for the named addressee and are confidential; any unauthorised use, reproduction or storage of the contents is expressly prohibited. If you have received this email in error, please delete it and any attachments immediately and advise the sender by return email or telephone.

Deakin University does not warrant that this email and any attachments are error or virus free.

β€” You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/ekothe/trackdown/issues/8#issuecomment-798795786, or unsubscribe https://github.com/notifications/unsubscribe-auth/AG6HXUPUVSW3NLFCN6KCJZDTDPRTNANCNFSM4YZFHIEA .

-- Filippo Gambarota PhD Student - University of Padova Department of Developmental and Social Psychology Website: filippogambarota.netlify.app Research Group: Colab http://colab.psy.unipd.it/ Psicostat https://psicostat.dpss.psy.unipd.it/