https://github.com/lgatto/2015-05-14-stellenbosch
Software Carpentry Bootcamp, Stellenbosch, South Africa
https://github.com/lgatto/2015-05-14-stellenbosch
Last synced: about 2 months ago
JSON representation
Software Carpentry Bootcamp, Stellenbosch, South Africa
- Host: GitHub
- URL: https://github.com/lgatto/2015-05-14-stellenbosch
- Owner: lgatto
- License: other
- Created: 2015-04-22T15:39:40.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2015-05-15T18:30:07.000Z (almost 10 years ago)
- Last Synced: 2025-03-11T10:09:31.836Z (about 2 months ago)
- Language: HTML
- Homepage: http://lgatto.github.io/2015-05-14-Stellenbosch/
- Size: 6.42 MB
- Stars: 1
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.html
Awesome Lists containing this project
README
r-novice-inflammation
=====================
Introduction to R for non-programmers using inflammation data.
The goal of this lesson is to teach novice programmers to write modular code to
perform a data analysis. R 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 R, but instead the focus is on
language agnostic principles like automation with loops and encapsulation with
functions (see [Best Practices for Scientific Computing][best-practices] to
learn more). In fact, this lesson is a translation of the [Python version][py],
and the lesson is also available in [MATLAB][].
The example used in this lesson is analyzing 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.
[best-practices]: http://journals.plos.org/plosbiology/article?id=10.1371/journal.pbio.1001745
[py]: https://github.com/swcarpentry/python-novice-inflammation
[MATLAB]: https://github.com/swcarpentry/matlab-novice-inflammation
## Contributing
Please see the current list of [issues][] for ideas for contributing to this
repository. For making your contribution, we use the GitHub flow, which is
nicely explained in the chapter [Contributing to a Project][pro-git] in Pro Git
by Scott Chacon.
General instructions for making contributions are summarised in [CONTRIBUTING.md](https://github.com/swcarpentry/r-novice-inflammation/blob/gh-pages/CONTRIBUTING.md).
When editing topic pages for R lessons, you should change the source R Markdown
file (*.Rmd). Only changes to R markdown files and other supporting files (e.g. data files) should be committed to Git.
To view how the changes will look, when viewed in a web browser, you can render the html pages by running `make preview` from the base of the repository. Generating the html file(s) is required for viewing the [online version of the lessons][online] (you can learn more about the design of the build process [here][design]). Building the rendered page with the Makefile requires installing some dependencies first. In addition to the dependencies listed in the [lesson template documentation][dependencies], you also need to install the R package [knitr][].
Once you've made your edits and rendered the corresponding html files,
you need to add, commit, and push just the source R Markdown file(s)
and any supporting files (e.g. data files). Changes generated by the `make preview` command should not be committed or included in a pull request. These changes will be taken care off by the lesson maintainer when the PR is merged.
[issues]: https://github.com/swcarpentry/r-novice-inflammation/issues
[pro-git]: http://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project
[dependencies]: https://github.com/swcarpentry/lesson-template#dependencies
[knitr]: http://cran.r-project.org/web/packages/knitr/index.html
[online]: http://swcarpentry.github.io/r-novice-inflammation/
[design]: https://github.com/swcarpentry/lesson-template/blob/gh-pages/DESIGN.md
## Getting Help
> Please see [https://github.com/swcarpentry/lesson-template](https://github.com/swcarpentry/lesson-template)
> for instructions on formatting, building, and submitting lessons,
> or run `make` in this directory for a list of helpful commands.
If you have questions or proposals, please send them to the [r-discuss][] mailing list.
[r-discuss]: http://lists.software-carpentry.org/mailman/listinfo/r-discuss_lists.software-carpentry.org