Modeling Steps 10
Modeling Steps 10¶
Content creators: Marius ‘t Hart, Megan Peters, Paul Schrater, Jean Laurens, Gunnar Blohm
Production editors: Spiros Chavlis
Step 10: publishing the model¶
Video 11: Publishing the modeling¶
Know your target audience!
How much math details? How much explanation of math?
What’s the message?
Should be experimentalists in most cases!!!
Provide intuitive explanations, analogies, etc.
Famous researcher: “a good modeller knows how to relate to experimentalists”
Clearly describe what the goals, hypotheses and performance criteria were
Prevents from false expectation of what the model should be doing
A graphical representation is worth 1000 words (or more)
Show model simulations in parallel to data
Much more convincing!
Publish enough implementation details
A good model has to be reproducible!
Goal: Make sure your model is well received AND USED by the community. In order for our model to impact the field, it needs to be accepted by our peers, and order for that to happen it matters how the model is published.
Make sure to avoid the pitfalls!
Click here for a recap on pitfalls
not thinking of your target audience
no one will understand you if you write for yourself because only you know what you know…
forgetting about Steps 1-4
clearly spelling out steps 1-4 allows the reader to appreciate your goals and sets limits on model criticism
no one can tell you your model didn’t do something you never set out to do
prevents unreasonable claims / rejection of paper
thinking you don’t need figures to explain your model
your model draft is a great starting point!
make figures that provide intuition about model behavior (just like you would create figures to provide intuition about expeimental data)
my code is too mesy to be published
not an option (many journal now rightfully require it)
code cleanly right from the start
model drafting should help with that
comment your code! Then comment more…
Writing the abstract of a modeling paper¶
Abstracts are very stereotyped pieces of writing that contain highly condensed information. To write a summary (= abstract) of your modeling, you can use these questions as a guide:
What is the phenomena? Here summarize the part of the phenomena which your modeling addresses.
What is the key scientific question?: Clearly articulate the question which your modeling tries to answer.
What was our hypothesis?: Explain the key relationships which we relied on to simulate the phenomena.
How did your modeling work? Give an overview of the model, it’s main components, and how the modeling works. ‘’Here we … ‘’
What did you find? Did the modeling work? Explain the key outcomes of your modeling evaluation.
What can you conclude? Conclude as much as you can with reference to the hypothesis, within the limits of the modeling.
What are the limitations and future directions? What is left to be learned? Briefly argue the plausibility of the approach and/or what you think is essential that may have been left out.
Instructions: write down your answer to each of those questions (1-2 sentences each, max!). When you’re done, stick the sentences together… Now you have an abstract!
Guidance for paper writing¶
There are good guidelines for structuring and writing an effective paper (e.g., Mensh & Kording, 2017), all of which apply to papers about models. There are some extra considerations when publishing a model. In general, you should explain each of the steps in the paper:
Introduction: Steps 1 & 2 (maybe 3)
Methods: Steps 3-7, 9
Results: Steps 8 & 9, going back to 1, 2 & 4
Here are some great materials to help you with paper writing:
In addition, you should provide a visualization of the model, and upload the code implementing the model and the data it was trained and tested on to a repository (e.g. GitHub and OSF).
For every modeling project, a very good exercise is to first write a short, 100-word abstract of the project plan and expected impact. This forces focussing on the main points: describing the relevance, question, model, answer and what it all means very succinctly. This allows you to decide to do this project or not before you commit time writing code for no good purpose. Notice that this is really what we’ve walked you through carefully in this guide! 😀
Blohm G, Kording KP, Schrater PR (2020). A How-to-Model Guide for Neuroscience. eNeuro, 7(1) ENEURO.0352-19.2019. doi: 10.1523/ENEURO.0352-19.2019
Kording KP, Blohm G, Schrater P, Kay K (2020). Appreciating the variety of goals in computational neuroscience. Neurons, Behavior, Data Analysis, and Theory 3(6). url:nbdt.scholasticahq.com/article/16723-appreciating-the-variety-of-goals-in-computational-neuroscience
Mensh B, Kording K (2017). Ten simple rules for structuring papers. PLOS Comput Biol 13(9): e1005619. 10.1371/journal.pcbi.1005619
Schrater PR, Peters MK, Kording KP, Blohm G (2019). Modeling in Neuroscience as a Decision Process. OSF pre-print. url: osf.io/w56vt