{"cells":[{"metadata":{},"cell_type":"markdown","source":"<img src=\"https://i.imgur.com/qYzpZ5X.jpg\" alt=\"corona\" width=\"600\">\n\nIt's great to see Kagglers contributing this way to fight the advance of Covid-19. I thought it might be helpful to share some thoughts on what makes a good report for this type of thing. My opinions come from experience being both the person reading reports and the person making reports - and the person getting told to revise and resubmit his report. Of course this notebook represents a single point of view, and you are probably best served by gathering many perspectives of what \"good\" looks like. "},{"metadata":{},"cell_type":"markdown","source":"# 1. Lead with the insights.\n\nIn case you read no further, I offer this idea as the one thing to make your report more impactful:\n\n> #### Put your bottom line up front. Lead with the best insight from your analysis.\n\nThis point is important, and not natural for scientists. We like to take the audience through our line of reasoning, with open minds, supported by data and charts with a bit of explanation. After they've followed along we present our conclusions.\n\nSometimes that's useful, but not so much here! Your audience consists of people looking for vital information in a limited amount of time. They'll be reading through a stack of reports looking for something that seems useful. So it's best to start with your conclusion, get the reader's interest, and give them a frame of reference from which to \"hang\" supporting information. Then, explain the details and show them how you got there. \n\nHere's the beginning of my report from the 2019 NFL Punt Analytics challenge:\n\n<hr>\n\n> ### Summary\n\n> This report represents my analysis for the NFL Punt Analytics Competition. It is my opinion that based on the data provided, changing two rules for punt plays could result in up to 8 fewer concussions per year. The two proposed changes are as follows:\n\n>  - <i>Move the ball forward 10 yards after a Fair Catch.</i> After fair catch of a scrimmage kick, play would start 10 yards forward from the spot of catch, or the succeeding spot after eforcement of penalties. This would apply when the receiving team elects to put the ball in play by a snap.\n\n>  - <i>Penalize blindside blocks with forcible contact to any part of a defenseless player's body.</i> Defenseless players as described by NFL rules include players receiving a blindside block from a blocker whose path is toward or parallel his own end line. Prohibited contact for punt plays would include blindside blocks with forcible contact to any part of a defenseless player's body, including below the neck.\n\n> The figure below shows the potential reduction in concussions based on 2016-2017 data and associated assumptions.\n\n\n<img src=\"https://s3.amazonaws.com/nonwebstorage/headstrong/redux.png\" alt=\"chart\" height=\"400\" width=\"600\">\n"},{"metadata":{"_uuid":"8f2839f25d086af736a60e9eeb907d3b93b6e0e5","_cell_guid":"b1076dfc-b9ad-4769-8c92-a6c4dae69d19","trusted":true},"cell_type":"markdown","source":"You can see there's minimal setup and then we get right to the point For the case at hand you might consider starting right away with your take on the existing research, based on data of course."},{"metadata":{},"cell_type":"markdown","source":"# 2.  Find a question that's worth answering.\n\nSometimes it can be hard to know where to focus. That's not so much the case here with the sponsors giving us an extensive list and subtopics to explore. But you still will need to be creative to find the best topics. One possiblity is that within an area of interest, find where the research intersects with what everyone is talking about. Some ideas off the top of my head, relevant to the US as that's where my experience is based:\n\n - How has media's influence on public perception changed relative to the days of newspapers and broadcast TV?\n - What will be the long term effects of the outbreak on the wealth gap in developed countries?\n - How does a nation's health care structure influence the short and long term effects of disease outbreaks?\n \n Another avenue may be to research two or more distinct areas and show how they complement one another.\n \n UPDATE: Other issues have risen in visibility as things progess:\n - How did governemnts react, and what has been the correlation of these reactions with the infection rate?\n - As countries restore freedom of movement after an outbreak, what happens in terms of infection rates?"},{"metadata":{},"cell_type":"markdown","source":"# 3. Spend time on your visualizations. \n\nThe art and science of visualization has become a field of study on it's own with many many things to learn. For now, here are some things you can consider to help your visualizations reinforce your message.\n\n- Keep it simple. Your audience should understand what they're looking at within a few seconds.\n- Use color to reinforce your message. Color is one of the \"preattentive attributes\" that people pick up on right away. A bar chart with mostly gray bars and one bar highlighted in color is a great way to focus attention. Along those lines, please don't use default seaborn bar charts with the rainbow of colors. Too much color can be worse than no color.\n- Tell the reader what to think. That might not sound right at first, but your chart should reinforce a point and it's ok to put that point front and center on the page.\n\nHere'an example from Tom Bresee's [Next-Gen EDA](https://www.kaggle.com/tombresee/next-gen-eda) notebok for the recent NFL Databowl competition. It uses a super-clean layout with great use of color. I find it much more effective than a regular old bar chart.\n\n<img src=\"https://i.imgur.com/cCgC2NM.png\" alt=\"schedule\" width=\"600\" height=\"500\">\n"},{"metadata":{},"cell_type":"markdown","source":"# 4. Make your notebook easy to read. \n\nNotice how I numbered my major headers for the notebook? That's one way to help keep your place as you scroll through. Here are some other things you can try.\n\n - You can use html tags and hierarchy to organize your notebook. Markdown is great for convenience and it's also flexible if you apply HTML tags. Here's an example of code for custom HTML to make section headers and structure that stand out. \n"},{"metadata":{"trusted":true},"cell_type":"code","source":"# %%HTML\n\n# This is the code for a code cell that sets the formats. Put it at the top of your notebook.\n\n# <style type=\"text/css\">\n\n# div.h2 {\n#     background-color: steelblue; \n#     color: white; \n#     padding: 8px; \n#     padding-right: 300px; \n#     font-size: 24px; \n#     max-width: 1500px; \n#     margin-top: 50px;\n#     margin-bottom:4px;\n# }\n\n\n\n# This is the actual HTML code you would put in a markdown cell .\n\n# <div class=h2>1. Section Title. </div>\n# Blah blah blah.","execution_count":null,"outputs":[]},{"metadata":{},"cell_type":"markdown","source":" - Make your code easy to read. There's an explicit request to do that for this challenge. One of the best resources I've found is this notebook [Six steps to more professional data science code](https://www.kaggle.com/rtatman/six-steps-to-more-professional-data-science-code). The sections on \"readable\" and \"stylish\" have great info."},{"metadata":{},"cell_type":"markdown","source":" - Another thing you might consider is to hide your code. Kaggle makes it easy with the \"hide input\" option. Normally, code is what we're all about and we're asked to have readable code. The last thing you probably want to do is hide it. But some of your readers don't code and even if they do, it's more important for them to first get the overall story if they're so inclined. Once you pass that first lookover, you can expect someone will dig into your code. "},{"metadata":{},"cell_type":"markdown","source":"# 5. Don't forget the stated criteria.\n\nMy perception is that the grading criteria were not strictly followed in previous analytics challenges. It's really more about what ideas can be used by the host to further their goals. You will need to meet the minimum bar, however, to be considered for selection. For example, be sure to have a section on pros and cons of your approach.\n\n"},{"metadata":{},"cell_type":"markdown","source":"# 6. Examples and Closing.\n\nHere are some good report-style notebooks from past analytics challenges, IMO:\n\n - https://www.kaggle.com/philippsinger/nfl-playing-surface-analytics-the-zoo\n - https://www.kaggle.com/gaborfodor/summary-budapest-pythons\n - https://www.kaggle.com/jpmiller/nfl-punt-analytics/#data\n - https://www.kaggle.com/erikbruin/recommendations-to-passnyc-1st-place-solution\n\n\n\n\nI hope these ideas are helpful and add to the quality of everyone's reports!"}],"metadata":{"kernelspec":{"language":"python","display_name":"Python 3","name":"python3"},"language_info":{"pygments_lexer":"ipython3","nbconvert_exporter":"python","version":"3.6.4","file_extension":".py","codemirror_mode":{"name":"ipython","version":3},"name":"python","mimetype":"text/x-python"}},"nbformat":4,"nbformat_minor":4}