Case Study Revision - Githubissues

We should revised our case-study through commits in our branch submissions. Once we are ok with the changes, we will open a new pull-request from the our branch submissions to the BIDS' one.

The deadline is April 8th.

Here is the issue message opened on the BIDS repo:

Your case study represents a useful and interesting example of reproducibility in applied scientific research, and we value this contribution. We’re requesting the addition of a Title, and some minor revisions to your Narrative and Diagram. We’d like to receive revised case studies no later than April 8th.

Introduction

[ ] Please provide a one sentence “title” for your case study (e.g., “Developing, testing, and deploying efficient MCMC algorithms for hierarchical models using R”, or an equivalent level of detail), at the very beginning of your case study, following the example below.
[ ] Please provide a short (1-2 sentences) description of your case study in your answer to question 1 in the introduction.

Narrative

[ ] Please shorten your case study to have 500-800 words. Right now, your case study has 1639 words, which we believe is too detailed and can be shortened. We are looking for a brief description of your study with the important computational workflow, presented in a simple and basic manner, such that someone outside your field can follow the basic steps. Your diagram is very clear and has the information we are looking for but your narrative gets lost in details sometimes.
[ ] Please read carefully checking for typos or grammatical errors
[ ] Please add (Barba, 2012) in the references
[ ] Please briefly describe “figshare, CC-BY” the first time you use in the text
[ ] Please define acronyms such as CFD (move from Introduction to Narrative), GPU,
[ ] Although we realize that a more detailed description about Krishnan et al. 2014 comes in the second paragraph in your narrative move the description about this study from the Introduction to the Narrative. In general, you could move some information from the Introduction to the Narrative. In the Introduction we are looking for a shorter 1-2 sentence description of your case study.
[ ] Please briefly elaborate any specific reason to use the CUSP library. Such information can be very helpful for the interested reader.
[ ] Is “IcoFOAM” part of “OpenFOAM” please state so if yes. This information is missing.
[ ] Please briefly explain the term “vorticity”, to help readers to follow your case study without prior knowledge.

Diagram

(The diagram is very clear and comprehensive we only request minor formatting.)

[ ] Please make the minimum font size in your diagram to be 10pt, and more ideally 11pt (space allowing), using Helvetica font (or similar).
[ ] Please add the labels “Stage I: Data Input”, “Stage II: Data Processing” and “Stage III: Data Analysis” to indicate the appropriate sections of your Diagram, following the examples in CaseStudies123.png as a guideline. These labels should be in Helvetica font, bold, 22pt.
[ ] Please change any color/grayscale in your diagram to black & white. You might consider using additional shaped boxes, or various outline styles for boxes (and adding a legend) to denote different types of information or tools.
[ ] Please reformat your Diagram to be horizontally (landscape) oriented. Further, your Diagram should occupy no more than 1/2 of a US letter page. This will require reorganizing your boxes.
[ ] Please provide both the PDF and editable source file for your Diagram.

Here is a traditional examples of a case study Narrative and Diagram, which represent both the style and degree of "concreteness" that we're looking for.

I know it’s late for you in DC. Can you be online tomorrow on Slack for any questions? I will go ahead and make edits on the submissions branch, for now.

Lorena A. Barba Associate Professor, Mechanical and Aerospace Engineering The George Washington University twitter.com/LorenaABarba http://twitter.com/LorenaABarba

On Apr 1, 2016, at 10:18 AM, Olivier Mesnard notifications@github.com wrote:

We should revised our case-study through commits in our branch submissions. Once we are ok with the changes, we will open a new pull-request from the our branch submissions to the BIDS' one.

The deadline is April 8th.

Here is the issue https://github.com/BIDS/repro-case-studies/issues/75 message opened on the BIDS repo:

Your case study represents a useful and interesting example of reproducibility in applied scientific research, and we value this contribution. We’re requesting the addition of a Title, and some minor revisions to your Narrative and Diagram. We’d like to receive revised case studies no later than April 8th.

Introduction

Please provide a one sentence “title” for your case study (e.g., “Developing, testing, and deploying efficient MCMC algorithms for hierarchical models using R”, or an equivalent level of detail), at the very beginning of your case study, following the example below. Please provide a short (1-2 sentences) description of your case study in your answer to question 1 in the introduction. Narrative

Please shorten your case study to have 500-800 words. Right now, your case study has 1639 words, which we believe is too detailed and can be shortened. We are looking for a brief description of your study with the important computational workflow, presented in a simple and basic manner, such that someone outside your field can follow the basic steps. Your diagram is very clear and has the information we are looking for but your narrative gets lost in details sometimes. Please read carefully checking for typos or grammatical errors Please add (Barba, 2012) in the references Please briefly describe “figshare, CC-BY” the first time you use in the text Please define acronyms such as CFD (move from Introduction to Narrative), GPU, Although we realize that a more detailed description about Krishnan et al. 2014 comes in the second paragraph in your narrative move the description about this study from the Introduction to the Narrative. In general, you could move some information from the Introduction to the Narrative. In the Introduction we are looking for a shorter 1-2 sentence description of your case study. Please briefly elaborate any specific reason to use the CUSP library. Such information can be very helpful for the interested reader. Is “IcoFOAM” part of “OpenFOAM” please state so if yes. This information is missing. Please briefly explain the term “vorticity”, to help readers to follow your case study without prior knowledge. Diagram

(The diagram is very clear and comprehensive we only request minor formatting.)

Please make the minimum font size in your diagram to be 10pt, and more ideally 11pt (space allowing), using Helvetica font (or similar). Please add the labels “Stage I: Data Input”, “Stage II: Data Processing” and “Stage III: Data Analysis” to indicate the appropriate sections of your Diagram, following the examples in CaseStudies123.png as a guideline. These labels should be in Helvetica font, bold, 22pt. Please change any color/grayscale in your diagram to black & white. You might consider using additional shaped boxes, or various outline styles for boxes (and adding a legend) to denote different types of information or tools. Please reformat your Diagram to be horizontally (landscape) oriented. Further, your Diagram should occupy no more than 1/2 of a US letter page. This will require reorganizing your boxes. Please provide both the PDF and editable source file for your Diagram. Here is a traditional examples of a case study Narrative and Diagram, which represent both the style and degree of "concreteness" that we're looking for.

— You are receiving this because you are subscribed to this thread. Reply to this email directly or view it on GitHub https://github.com/barbagroup/repro-case-studies/issues/2

barbagroup / repro-case-studies

Case Study Revision #2