Blog post

Question

Blog post

Closed this issue 4 years ago · 29 comments

I'll do a blog post on how we made the templates, how to use the package, the value of design in communicating results, etc.

tvroylandt commented 4 years ago

Yes

👍1

Answer 1 · 2020-12-14T07:55:23.000Z

You can start using and testing the package. It's not totally done but it's on a good way.

If you need some explanations on how it works, you have three functions (named after the first image I used for them) :

paged_windmill
paged_hazelnuts
paged_grid

For all of them you can use a standard header like this :

---
title: "Title of the report"
subtitle: "Subtitle of the report"
author: "Author Name"
date: "Date"
output:
  pagedreport::paged_hazelnuts:
    front_img: "https://mk0rfortheresto0o08q.kinstacdn.com/wp-content/uploads/2020/08/math.jpg"
    back_img: "https://mk0rfortheresto0o08q.kinstacdn.com/wp-content/uploads/2020/08/math.jpg"
    logo: "https://mk0rfortheresto0o08q.kinstacdn.com/wp-content/uploads/2020/08/rru-logo-blue.svg"
    img_to_dark: TRUE
    logo_to_white: TRUE
knit: pagedown::chrome_print
toc-title: "Table of Contents"
main-color: "#ff2266"
secondary-color: "#aabbcc"
common-font: "IBM Plex Serif"
top-font: "IBM Plex Sans"
---

Some arguments could be useless on one or the other templates but the core is always the same.

With some combinations of images/logo/fonts/colors we can do whatever we want.

Answer 2 · 2020-12-14T08:05:27.000Z

I made a Christmas version :

Header for that :

---
title: "Annual North"
subtitle: "Christmas activity report"
author: "Sante Claus"
date: "December 2020"
output:
  pagedreport::paged_hazelnuts:
    front_img: "https://images.pexels.com/photos/717988/pexels-photo-717988.jpeg?auto=compress&cs=tinysrgb&h=750&w=1260"
    back_img: "https://images.pexels.com/photos/3303615/pexels-photo-3303615.jpeg?auto=compress&cs=tinysrgb&dpr=1&w=500"
    logo: "https://www.flaticon.com/svg/static/icons/svg/268/268225.svg"
    img_to_dark: TRUE
    logo_to_white: TRUE
knit: pagedown::chrome_print
toc-title: "Table of Contents"
main-color: "#E40A2D"
secondary-color: "#00873E"
common-font: "Raleway"
top-font: "Mountains of Christmas"
---

I still have some problems with blank pages on this one.

Answer 3 · 2020-12-14T14:58:30.000Z

Ok, great. I can start testing and write up a blog post this week. It might be helpful if we had a short call to discuss how exactly everything works so I can write it up accurately. Do you want to find a time using this link?

Answer 4 · 2020-12-14T15:02:11.000Z

Good idea ! I schedule something today

Answer 5 · 2020-12-14T15:05:10.000Z

Ok, sounds good. I've got meetings until then so I won't have time to review the code beforehand, but hopefully you can just walk me through how it works.

Answer 6 · 2020-12-14T15:07:12.000Z

Yes !
It will also be useful to talk about what we still have to do before releasing it

Answer 7 · 2021-01-04T23:32:08.000Z

Hope you had a good holiday break! I'm going to work on a blog post and video in the next couple days. Is there anything left to do on the code that I should wait for?

Answer 8 · 2021-01-05T14:25:16.000Z

It's was nice yes ! I wish you a happy new year full of good projetcs and code !

Normally, everything is fine on the code side. I just have some documentation to write now.

Answer 9 · 2021-01-05T15:43:12.000Z

Ok, I'm working on this now. I'll post questions as I come up with them.

First, when I create a new RMarkdown, the title of the templates varies. You can see how one is Paged windmill while the others have underscores between words (paged_grid and paged_hazelnuts).

Screen.Recording.2021-01-05.at.7.38.46.AM.mov

I made this consistent in 5d5a440

Answer 10 · 2021-01-05T15:43:43.000Z

Related, I see that there is a nuts template and a hazelnuts template. I assume the nuts template is redundant now and should be deleted, correct?

Answer 11 · 2021-01-05T15:50:11.000Z

Actually, I'm going to create new issues as I see things. That will be much easier to keep organized. Moved to the question above to #16

Answer 12 · 2021-01-06T23:06:41.000Z

I've got a draft blog post ready. Let me know what you think.

One thing is that the images showing the default reports are too small. Do you have a way to easily make bigger versions? I can work on it if not.

Answer 13 · 2021-01-07T08:08:04.000Z

Awesome ! You really know how to write !
I will send better images in the next couple of days

Answer 14 · 2021-01-07T14:53:51.000Z

Sounds good! I'm thinking at this point that we can try to release the package middle of next week. Once you have the documentation ready, I'll record a video (maybe Monday?) and then we can wrap everything up Tuesday before releasing Wednesday. Sound good?

Answer 15 · 2021-01-08T19:02:07.000Z

Could you just tell me which images you used ? I wanted to redo them from the blog post but the links expired.

Answer 16 · 2021-01-08T21:58:27.000Z

I used the images posted above in this issue.

Answer 17 · 2021-01-08T21:59:17.000Z

Oh wait, you mean which specific ones. Hang on. Try this link.

Answer 18 · 2021-01-10T16:12:22.000Z

I sent you better images by mail. I had to screenshot pages one by one and added evrything together with Gimp.

Answer 19 · 2021-01-11T18:46:40.000Z

Got them, thanks. I'll work on it this afternoon.

Answer 20 · 2021-01-12T16:08:10.000Z

Ok, I've updated the blog post. I actually ended up converting the PDFs to animated GIFs.

I can record the video walkthrough this afternoon and then we should be all set. Just let me know what you think about the issue (#18) I created on changing argument names.

Answer 21 · 2021-01-12T19:54:05.000Z

Nice ! I'm on this now

Answer 22 · 2021-01-12T21:42:05.000Z

Super! I'll do the video now.

Answer 23 · 2021-01-13T19:54:04.000Z

Was working on the video and got most of the way through it. We just need the issues I created resolved and then I'll finish recording. How about we plan to release on Monday?

Answer 24 · 2021-01-13T20:15:26.000Z

Good idea ! Fine for me

Answer 25 · 2021-01-13T20:26:59.000Z

Ok, perfect. I'm not sure my video will be quite ready for tomorrow and Friday is a bad day to release things.

Answer 26 · 2021-01-14T00:29:03.000Z

Ok, video is ready for you to review. Take a look and let me know if everything looks good to you!

Answer 27 · 2021-01-14T07:12:37.000Z

This is very clear. I really like the video ! Geat work David !

Answer 28 · 2021-01-14T15:42:15.000Z

Awesome! I just made a slightly edited version that zooms in on code to make it more legible. I'll add that to the blog post and schedule it to go public Monday morning. I'll also set up a couple tweets to go out on Monday.