Update cheatsheet

[jhollway]

https://www.rstudio.com/resources/cheatsheets/how-to-contribute-a-cheatsheet/

[EstherPeev]

@jhollway Please find below the first draft of the cheat sheet that I have prepared for qCreate. I am still working on the one for qData.

https://app.zenhub.com/files/291753904/00b24121-6e84-424c-8e6d-78ffde4047a0/download

Also @henriquesposito let me know if you have any ideas or suggestions on how to improve it or if you think something is unclear.

[jhollway]

This is excellent @EstherPeev ! Really useful examples, etc. I'll take a closer look tomorrow, but one thing that might be nice to include if we have the space is something about where testing enters into the workflow.

[henriquesposito]

Really great work @EstherPeev !

I like the visuals a lot. The only suggestions I have are regarding the blue overarching squares, I would leave only setup_package() and export_data() within the blue squares (not import_data()) as they are the only ones with the comments also in a blue box and are the first and last step of using qCreate. Alternatively, I also like the blue text box style for explaining arguments of functions, maybe we can do it for all of the functions instead of describing what they do.

In any case, really great work!

[EstherPeev]

@jhollway Yes thank you I indeed forgot the test parts, I'll add it to the cheat sheet.
@henriquesposito Yes, I agreee with you I will see if I can add the little blue boxes for all the functions to explain the arguments.

[EstherPeev]

Here is the second draft:

https://app.zenhub.com/files/291753904/dbe38a47-ce8e-4c0e-b7bb-e33f181e9c33/download

I have added few words on the tests functionality in the process part and I've also adjusted the blue boxes and the blue square background. Please let me know if anything else is missing or need to be modified.

[EstherPeev]

Here is the third draft:

https://app.zenhub.com/files/291753904/a2ad3269-c690-47b9-a682-09b05f59454a/download

I tried to incorporate all of your comments/suggestions. I have also added the background color for the bottom part to match with the upper part. Please let me know what you think of this one.

@henriquesposito @jhollway

[henriquesposito]

I like the colors a lot, great job @EstherPeev ! Maybe even try three different colors or shades to the same color, if possible, because we have three different processes (collect, correct and connect).

I do think we should take the "" from the arguments and the $ and just leave the simple argument without specifying, especially because we are not using any real examples; for example: code_agreements(dataset, title, date).

Once again, good job! It does make more sense and it is getting better.

[EstherPeev]

Thanks for the feedback and suggestions @henriquesposito and @jhollway I have tried to incorporate all of them in this version of the cheat sheet:

https://app.zenhub.com/files/365543800/a542d915-f1f0-4d03-b726-bf879bb58abf/download

Please let me know if I missed anything.

[EstherPeev]

Here is a new version of the cheat sheet with few minor changes.

https://app.zenhub.com/files/365543800/7268b860-c9c8-40da-a94a-82f67a9ee0a3/download

To be modified once code_agreements() new version with code_acronym() is finished.

[henriquesposito]

Great job @EstherPeev ! I like this version of the cheat sheet a lot.

The only comment I have at the moment pertains the description you have for code_agreements(), in the bottom section of the documents (functions), that is the only function for the bottom section that has a description. I wonder if we need the description? I am really just wondering here, what do you think?

[EstherPeev]

Thanks for the feedback @henriquesposito !

As the other functions' utility seem a bit more intuitive, I thought adding a description for code_agreements() would make this clearer. But maybe we don't need it if you think the table is enough for the reader to understand what it does?