Difference between revisions of "20.109(S16): System engineering report"
MAXINE JONAS (Talk | contribs) (→Introduction) |
Noreen Lyell (Talk | contribs) |
||
| Line 32: | Line 32: | ||
Your system engineering report is '''due by 5 pm''' on <font color = red> Sunday, Nov 15th</font color>. | Your system engineering report is '''due by 5 pm''' on <font color = red> Sunday, Nov 15th</font color>. | ||
| + | ==Overview== | ||
| − | + | The culminating assignment for Module 2 will be a research article in which you describe your systems engineering investigation. The term ''research article'' (as opposed to ''laboratory report'') is meant to indicate your growing maturity as scientific writers, and our growing expectations of you. While your Module 1 assignments contained many of the same elements that you'll include here, the research article will be a more complete, cohesive, and formal document. Your Module 2 paper should approach the quality of the primary scientific literature (excepting its lack of experiment repetition), especially with respect to explaining rather than merely documenting your observations. For more information about research articles vs. laboratory reports see [[20.109%28F09%29:_System_engineering_research_article#Writing_a_.22research_article.22_versus_a_.22lab_report.22 | '''here''']]. | |
| − | + | ==Logistics== | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | === | + | ===Method of Submission=== |
| − | + | Please submit your completed report on [http://stellar.mit.edu/S/course/20/sp15/20.109/ '''Stellar'''], with filename <font color = 990000>'''FirstName_LastInitial_LabSection_Mod2.doc'''</font color> (for example, Raphael_R_TR_Mod2.doc). Late assignments should be submitted on Stellar as well. | |
| − | + | You will complete this assignment individually. Please review the 20.109 [[20.109(S15):Statement_on_collaboration_and_integrity | '''statement on collaboration and integrity''']] as you proceed. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ===Date of Submission: <font color = CC0000><b>April 20th</b></font color>=== | |
| − | + | The final draft of your research article is '''due by 5 pm on April 20th (Monday)''' for everyone. | |
| − | + | ===Formatting Expectations=== | |
| − | + | *Your main document (excluding figures) should be/have | |
| + | ** .docx (preferred) or .pdf | ||
| + | ** 12-pt font | ||
| + | ** with 1-inch margins | ||
| + | ** 1.5 or double spaced (excepting the abstract) | ||
| + | * Figures can be made in a separate drawing program (such as powerpoint), and should be submitted as .pdf | ||
| − | + | ===Guidelines on Length=== | |
| − | + | Not counting figures, report length should not exceed 13 pages. The following rough division is recommended: | |
| − | = | + | <font color=FF33FF>'''Please take the following guidelines with a grain of salt.'''</font color> You will not be penalized for going modestly over a section limit if you are being thorough yet concise. Conversely, you might technically stay within a section limit yet use more space than your content warrants, which would lower your evaluation. |
| − | + | *Introduction: 2-2.5 pages | |
| + | *Methods: 3ish pages | ||
| + | *Results: 3ish pages | ||
| + | *Discussion: 2-3 pages | ||
| − | + | '''Concise writing is appreciated and rewarded! In other words, longer is not always better.''' | |
| − | + | ==Content Guidelines== | |
| + | |||
| + | Begin by reading the [[20.109%28S15%29:Guidelines_for_writing_up_your_research | '''general guidelines for scientific writing''']]. A few notes specific to Module 2 are below: | ||
| + | |||
| + | ===Introduction=== | ||
| + | |||
| + | Recall from the scientific writing guidelines the [[20.109%28S15%29:Guidelines_for_writing_up_your_research#Introduction | '''funnel structure for the introduction''']], and also review the [[20.109%28S15%29:Cell_preparation_for_DNA_repair_assays_%28Day4%29#Homework | '''specific guiding questions''']] in the M2D4 FNT. Be sure to pay close attention to the feedback you've been given on your homework. Also, you may find that the [http://bewritinglab.mit.edu '''BE Communications Lab'''] is a terrific resource for providing suggestions on your Introduction. If the peer tutors in the BE Communications Lab, a scientifically literate audience, understand your motivation for the study -- you are in good shape! | ||
| + | |||
| + | The Introduction section will be evaluated by your lab instructors (Shannon or Leslie & Noreen) and will account for ~15% of your total grade. | ||
===Methods=== | ===Methods=== | ||
| − | The methods section | + | The methods section will be evaluated by your lab section instructor (Shannon or Noreen & Leslie) and be worth approximately 10% of the report grade. Please take full advantage of the feedback that you receive on your homework. |
| − | + | ===Results and Figures=== | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ====Individual versus class-wide data==== | |
| − | + | You may take an approach similar to what you did in Module 1. More explicitly, you should present just your individual results for all of the validation experiments. You may ''briefly'' comment on class-wide consistency if you wish. For the investigative flow cytometry experiment, you should take a class-wide view. | |
| − | + | ====Suggested figures==== | |
| + | |||
| + | The suggested list of figures below should be suitable for most of your write-ups (not necessarily in this order!), but you are welcome to make additions/deletions/modifications as you see fit. Be sure to present the data in '''whatever progression you feel tells the most logical story'''. Remember that the order of our experiments does not necessarily correspond to the best way to tell the story of this investigation. | ||
*Schematics/diagrams | *Schematics/diagrams | ||
| − | ** | + | **Overall approach (not every single method to get there!) and question being asked |
| − | ** | + | **Often the overview schematic is designed to support the first/overview paragraph of the Results section |
*Figures | *Figures | ||
| − | ** | + | **Ku80 immunoblot |
| − | ** | + | **NHEJ inhibitor dose response curve |
| − | ** | + | **Post-digest DNA gel |
| − | * | + | **Select raw flow cytometry images |
| − | ** | + | ***Not all 12 of yours! |
| − | ** | + | ***Ideally show how gating was determined, followed by one or two experimental plots |
| − | ** | + | *Figures and possibly also Tables |
| − | + | **Class-wide flow cytometry results | |
| − | + | **Ultimately interested in NHEJ repair values for different conditions | |
| + | ***Vertical bar plot with 95% confidence interval error bars is one good representation | ||
| + | **Perform statistical comparisons where possible | ||
| + | ***We're fine with t-tests for 20.109 purposes, but you can use ANOVA or other multiple-comparison approaches if you wish | ||
| + | **Some comment on interim results (e.g., typical B/G ratio and its consistency in intact case) is fine | ||
| + | **Remember that some data may be excluded for ''clear and consistently applied'' reasons | ||
| − | ===Discussion=== | + | ===Discussion and Citations=== |
| − | This section should realize all the good practices described in the Module 1 assignment, but do so at a more advanced level. You will be expected to cite the broader scientific literature more thoroughly than before to inform your analysis in the discussion. You should also propose specific future experiments and otherwise show that you deeply understand the meaning and significance of your results; for example, if you have a hypothesis about why a | + | This section should realize all the good practices described in the Module 1 assignment in regards to concisely stating conclusions about your research, but do so at a more advanced level. You will be expected to cite the broader scientific literature more thoroughly than before, both to set up your investigative question in the introduction and to inform your analysis in the discussion. You should also propose specific future experiments and otherwise show that you deeply understand the meaning and significance of your results; for example, if you have a hypothesis about why a DNA topology had the relative repair frequency that it did, consider what follow-up experiments you might try. Also, make sure to do a bit of literature digging to determine if your results have any precedent or if your experiments are contrary to what has been reported. Modest speculation as to why that it the case is ''highly'' encouraged. The best scientific writers are creative in their discussion sections – convincing their readers that whatever the results, the study was interesting and contributes to forward movement of the field. |
| − | + | You will need to include a References section in your report. Follow the guidelines [[20.109%28S15%29:Guidelines_for_writing_up_your_research#References| '''here''']]. | |
==Evaluation== | ==Evaluation== | ||
| − | The full descriptive rubric for lab reports can be found on the [[20.109% | + | The full descriptive rubric for lab reports can be found on the [[20.109%28S15%29:Guidelines_for_writing_up_your_research#Evaluation | '''guidelines page''']]. Introduction and Methods will be graded by Shannon/Noreen/Leslie (~25% of total grade) and the rest of the report will be graded by Professor Samson (~75% of total grade). |
Revision as of 00:47, 3 January 2016
Link back to Module 2.
Overview
The culminating assignment for Module 2 will be a research article in which you describe your system engineering investigation. The term research article (as opposed to laboratory report) is meant to indicate your growing maturity as scientific writers, and our growing expectations of you. Your Module 2 paper should approach the quality of the primary scientific literature (excepting its lack of experiment repetition), especially with respect to explaining rather than merely documenting your observations.
The target audience for this report is a scientifically literate reader who is unfamiliar with your specific field. Thus, you can assume rapid comprehension – but not a priori knowledge – of technical information, and consequently should strive to present your work in a logical, step-by-step fashion.
Writing a "research article" versus a "lab report"
A quick but unscientific survey of several journal's "instructions for authors" shows some common themes that are worth considering here. For instance, the instructions from JCB say:Clearly the goal of published research is not merely to catalog or describe observations but to collect the information into some coherent story that advances general understanding and provides insights that others can use. This is the critical difference between a "lab report" which primarily describes your observations and the "research article" you'll write which invites you to share the insights your data gives. Here you must frame your results to address a larger question that's of general interest to the community. Many of the format instructions that applied to a lab report also apply to your research article, but keep in mind how the intention of the two written assignments differs.
Be sure to review the 20.109 statement on collaboration and integrity as you proceed.
Logistics
You will complete this assignment individually.
Method of submission
Please submit your completed summary on Stellar, with filename Name_LabSection_Mod2.doc (for example, NoreenLyell_TR_Mod2.doc).
Date of submission: Nov 15th
Your system engineering report is due by 5 pm on Sunday, Nov 15th.
Overview
The culminating assignment for Module 2 will be a research article in which you describe your systems engineering investigation. The term research article (as opposed to laboratory report) is meant to indicate your growing maturity as scientific writers, and our growing expectations of you. While your Module 1 assignments contained many of the same elements that you'll include here, the research article will be a more complete, cohesive, and formal document. Your Module 2 paper should approach the quality of the primary scientific literature (excepting its lack of experiment repetition), especially with respect to explaining rather than merely documenting your observations. For more information about research articles vs. laboratory reports see here.
Logistics
Method of Submission
Please submit your completed report on Stellar, with filename FirstName_LastInitial_LabSection_Mod2.doc (for example, Raphael_R_TR_Mod2.doc). Late assignments should be submitted on Stellar as well.
You will complete this assignment individually. Please review the 20.109 statement on collaboration and integrity as you proceed.
Date of Submission: April 20th
The final draft of your research article is due by 5 pm on April 20th (Monday) for everyone.
Formatting Expectations
- Your main document (excluding figures) should be/have
- .docx (preferred) or .pdf
- 12-pt font
- with 1-inch margins
- 1.5 or double spaced (excepting the abstract)
- Figures can be made in a separate drawing program (such as powerpoint), and should be submitted as .pdf
Guidelines on Length
Not counting figures, report length should not exceed 13 pages. The following rough division is recommended:
Please take the following guidelines with a grain of salt. You will not be penalized for going modestly over a section limit if you are being thorough yet concise. Conversely, you might technically stay within a section limit yet use more space than your content warrants, which would lower your evaluation.
- Introduction: 2-2.5 pages
- Methods: 3ish pages
- Results: 3ish pages
- Discussion: 2-3 pages
Concise writing is appreciated and rewarded! In other words, longer is not always better.
Content Guidelines
Begin by reading the general guidelines for scientific writing. A few notes specific to Module 2 are below:
Introduction
Recall from the scientific writing guidelines the funnel structure for the introduction, and also review the specific guiding questions in the M2D4 FNT. Be sure to pay close attention to the feedback you've been given on your homework. Also, you may find that the BE Communications Lab is a terrific resource for providing suggestions on your Introduction. If the peer tutors in the BE Communications Lab, a scientifically literate audience, understand your motivation for the study -- you are in good shape!
The Introduction section will be evaluated by your lab instructors (Shannon or Leslie & Noreen) and will account for ~15% of your total grade.
Methods
The methods section will be evaluated by your lab section instructor (Shannon or Noreen & Leslie) and be worth approximately 10% of the report grade. Please take full advantage of the feedback that you receive on your homework.
Results and Figures
Individual versus class-wide data
You may take an approach similar to what you did in Module 1. More explicitly, you should present just your individual results for all of the validation experiments. You may briefly comment on class-wide consistency if you wish. For the investigative flow cytometry experiment, you should take a class-wide view.
Suggested figures
The suggested list of figures below should be suitable for most of your write-ups (not necessarily in this order!), but you are welcome to make additions/deletions/modifications as you see fit. Be sure to present the data in whatever progression you feel tells the most logical story. Remember that the order of our experiments does not necessarily correspond to the best way to tell the story of this investigation.
- Schematics/diagrams
- Overall approach (not every single method to get there!) and question being asked
- Often the overview schematic is designed to support the first/overview paragraph of the Results section
- Figures
- Ku80 immunoblot
- NHEJ inhibitor dose response curve
- Post-digest DNA gel
- Select raw flow cytometry images
- Not all 12 of yours!
- Ideally show how gating was determined, followed by one or two experimental plots
- Figures and possibly also Tables
- Class-wide flow cytometry results
- Ultimately interested in NHEJ repair values for different conditions
- Vertical bar plot with 95% confidence interval error bars is one good representation
- Perform statistical comparisons where possible
- We're fine with t-tests for 20.109 purposes, but you can use ANOVA or other multiple-comparison approaches if you wish
- Some comment on interim results (e.g., typical B/G ratio and its consistency in intact case) is fine
- Remember that some data may be excluded for clear and consistently applied reasons
Discussion and Citations
This section should realize all the good practices described in the Module 1 assignment in regards to concisely stating conclusions about your research, but do so at a more advanced level. You will be expected to cite the broader scientific literature more thoroughly than before, both to set up your investigative question in the introduction and to inform your analysis in the discussion. You should also propose specific future experiments and otherwise show that you deeply understand the meaning and significance of your results; for example, if you have a hypothesis about why a DNA topology had the relative repair frequency that it did, consider what follow-up experiments you might try. Also, make sure to do a bit of literature digging to determine if your results have any precedent or if your experiments are contrary to what has been reported. Modest speculation as to why that it the case is highly encouraged. The best scientific writers are creative in their discussion sections – convincing their readers that whatever the results, the study was interesting and contributes to forward movement of the field.
You will need to include a References section in your report. Follow the guidelines here.
