README.md: add 'About the Lesson' section #556
Conversation
README.md
Outdated
| perform a data analysis. Python is used to teach these skills because it is a | ||
| commonly used programming language in many scientific disciplines. However, the | ||
| emphasis is not on teaching every aspect of Python, but instead on | ||
| language agnostic principles like automation with loops and encapsulation with |
README.md
Outdated
| emphasis is not on teaching every aspect of Python, but instead on | ||
| language agnostic principles like automation with loops and encapsulation with | ||
| functions (see [Best Practices for Scientific Computing][best-practices] to | ||
| learn more). This lesson is also available in [R][R] |
There was a problem hiding this comment.
This lesson... deserves a separate paragraph
README.md
Outdated
| and [MATLAB][MATLAB]. | ||
|
|
||
| The example used in this lesson analyzes a set of 12 data files with | ||
| inflammation data collected from a trial for a new treatment for arthritis (the data was simulated). Learners are shown how it is better to create a function and apply it to each of the 12 files using a loop instead of using copy-paste to analyze the 12 files individually. |
There was a problem hiding this comment.
I like the idea of having such a paragraph, but not the current wording of it.
There was a problem hiding this comment.
Also, it might be useful to add a small title like About the lesson or similar
There was a problem hiding this comment.
I like the idea @Josh-Woodcock had to give an overview of what the lesson is about (like for the R lesson in the README file).
And @maxim-belkin your suggestion to add "About the lesson" will help to highlight this paragraph.
There was a problem hiding this comment.
I prefer to keep titles such as Contributing, Maintainers, Authors, Citation, etc. But as suggested by @maxim-belkin , adding "About the lesson" is a very good idea.
maxim-belkin
added
the
status:changes requested
|
I impleneted the suggestion of adding an "About the Lesson" section, and amended the wording and formatting. The rest of the README.md has been left as is. |
…more fully formed. - put maintainers in a list, easier to read - add a short introduction = add links to other language versions of lesson (R and MATLAB)
Josh-Woodcock
force-pushed
the
readme
branch
from
25383ce
to
f121ed2
Compare
README.md
Outdated
| This lesson teaches novice programmers to write modular code to perform data analysis using Python. However, the emphasis is on teaching language-agnostic principles such as automation with loops and encapsulation with functions (see [Good enough practices in scientific computing][good-enough-practices] to | ||
| learn more). | ||
|
|
||
| The example used in this lesson analyses a set of 12 data files with inflammation data collected from a trial for a new treatment for arthritis (the data was simulated). Learners are shown how it is better to create a function and apply it to each of the 12 files using a loop instead of using copy-paste to analyse the 12 files individually. |
There was a problem hiding this comment.
the data was simulated ~> simulated data
There was a problem hiding this comment.
I think the last sentence could be improved. Don't mention a loop. Use phrases like Python enables ... and automation when talking about Python, and , error-prone (or similar) when talking about analysis done "by hand".
- Clarified wording
- Point to Best Practices - Move the one-line summary outside the `About the Lesson` section - Remove parentheses - Minor fixes (commas, articles, etc)
There was a problem hiding this comment.
Looks good to me @Josh-Woodcock ! Thank you! I added my changes directly to your branch. Feel free to comment on them if you think they're not appropriate.
|
@annefou, please have a look at this PR when you get a chance. |
maxim-belkin
changed the title
About the Lesson section
maxim-belkin
changed the title
About the Lesson section
maxim-belkin
added
high priority
|
Thank you very much, @Josh-Woodcock! |
* Added "About the Lesson" section. * Cleaned up formatting. Pull Request: #556
#495 Improve README.md
Based swcarpentry/r-novice-inflammation README