Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md: add 'About the Lesson' section #556

Merged
merged 5 commits into from
Oct 2, 2018
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
# Programming with Python

Josh-Woodcock marked this conversation as resolved.
Show resolved Hide resolved
[![GitHub release](https://img.shields.io/github/release/swcarpentry/python-novice-inflammation.svg)](https://github.com/swcarpentry/python-novice-inflammation/releases)
[![Create a Slack Account with us](https://img.shields.io/badge/Create_Slack_Account-The_Carpentries-071159.svg)](https://swc-slack-invite.herokuapp.com/)
[![Slack Status](https://img.shields.io/badge/Slack_Channel-swc--py--inflammation-E01563.svg)](https://swcarpentry.slack.com/messages/C9Y0L6MF0)


## About the Lesson

An introduction to Python for non-programmers using inflammation data.

Josh-Woodcock marked this conversation as resolved.
Show resolved Hide resolved
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
Josh-Woodcock marked this conversation as resolved.
Show resolved Hide resolved
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the data was simulated ~> simulated data

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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".


Rendered version of the lesson: <https://swcarpentry.github.io/python-novice-inflammation/>

This lesson is also available in [R][R] and [MATLAB][MATLAB].


## Contributing
[![Travis Build Status](https://travis-ci.org/swcarpentry/python-novice-inflammation.svg?branch=gh-pages)](https://travis-ci.org/swcarpentry/python-novice-inflammation)

Expand Down Expand Up @@ -39,3 +51,14 @@ To cite this lesson, please consult with [CITATION](CITATION)
[valentina_staneva]: http://software-carpentry.org/team/#staneva_valentina
[greg_wilson]: https://github.com/gvwilson
[swc_history]: https://software-carpentry.org/scf/history/
<<<<<<< HEAD
<<<<<<< HEAD
[best-practices]: http://journals.plos.org/plosbiology/article?id=10.1371/journal.pbio.1001745
=======
[good-enough-practices]: http://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1005510
>>>>>>> - added "About the Lesson" section.
=======
[good-enough-practices]: http://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1005510
>>>>>>> - Cleaned up formatting
Josh-Woodcock marked this conversation as resolved.
Show resolved Hide resolved
[R]: https://github.com/swcarpentry/r-novice-inflammation
[MATLAB]: https://github.com/swcarpentry/matlab-novice-inflammation
Josh-Woodcock marked this conversation as resolved.
Show resolved Hide resolved