Skip to content

Commit

Permalink
Merge pull request #497 from swirldev/dev
Browse files Browse the repository at this point in the history
Update to 2.4.2
  • Loading branch information
seankross authored Jun 23, 2016
2 parents d94dcc5 + 0048efd commit d85769b
Show file tree
Hide file tree
Showing 8 changed files with 52 additions and 24 deletions.
7 changes: 3 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Description: Use the R console as an interactive learning
environment. Users receive immediate feedback as they are guided through
self-paced lessons in data science and R programming.
URL: http://swirlstats.com
Version: 2.4.1
Version: 2.4.2
License: MIT + file LICENSE
Authors@R: c(
person("Sean", "Kross", email = "sean@seankross.com", role = c("aut", "cre")),
Expand All @@ -15,16 +15,15 @@ Authors@R: c(
person("Wush", "Wu", role = "ctb")
)
Depends:
R (>= 3.0.2)
R (>= 3.1.0)
Imports:
stringr,
testthat,
testthat (>= 1.0.2),
httr (>= 1.1.0),
yaml,
RCurl,
digest,
tools,
utils,
methods
Suggests:
stringi
Expand Down
1 change: 0 additions & 1 deletion NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ export(swirl_options)
export(uninstall_all_courses)
export(uninstall_course)
export(zip_course)
import(utils)
importFrom(RCurl,base64)
importFrom(RCurl,getForm)
importFrom(RCurl,postForm)
Expand Down
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# swirl 2.4.2

* Script questions behave more appropriately in RStudio. (#434, thank you @jimhester)

# swirl 2.4.1

* Added new answer test: `calculates_same_value()`.
Expand Down
5 changes: 5 additions & 0 deletions R/global.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
utils::globalVariables(c("URLencode", "browseURL", "capture.output",
"file.edit", "getS3method", "head", "install.packages",
"packageVersion", "read.csv", "select.list", "sessionInfo",
"setTxtProgressBar", "tail", "txtProgressBar", "unzip",
"zip"))
1 change: 0 additions & 1 deletion R/swirl.R
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@
#' @export
#' @importFrom stringr str_c str_trim str_split str_length
#' @importFrom stringr str_detect str_locate fixed str_split_fixed
#' @import utils
#' @importFrom methods is
#' @examples
#' \dontrun{
Expand Down
47 changes: 37 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,35 @@
# swirl

[![Build Status](https://travis-ci.org/swirldev/swirl.png?branch=master)](https://travis-ci.org/swirldev/swirl)
[![CRAN version](http://www.r-pkg.org/badges/version/swirl?color=3399ff)](https://cran.r-project.org/web/packages/swirl/index.html)
[![Downloads](http://cranlogs.r-pkg.org/badges/swirl?color=3399ff)](http://cran-logs.rstudio.com/)

### [http://swirlstats.com](http://swirlstats.com)

swirl is a platform for learning (and teaching) statistics and R simultaneously and interactively. It presents a choice of course lessons and interactively tutors a user through them. A user may be asked to watch a video, to answer a multiple-choice or fill-in-the-blanks question, or to enter a command in the R console precisely as if he or she were using R in practice. Emphasis is on the last, interacting with the R console. User responses are tested for correctness and hints are given if appropriate. Progress is automatically saved so that a user may quit at any time and later resume without losing work.
swirl is a platform for learning (and teaching) statistics and R simultaneously
and interactively. It presents a choice of course lessons and interactively
tutors a student through them. A student may be asked to watch a video, to answer a
multiple-choice or fill-in-the-blanks question, or to enter a command in the R
console precisely as if he or she were using R in practice. Emphasis is on the
last, interacting with the R console. User responses are tested for correctness
and hints are given if appropriate. Progress is automatically saved so that a
user may quit at any time and later resume without losing work.

swirl leans heavily on exercising a student's use of the R console. A callback mechanism, suggested and first demonstrated for the purpose by Hadley Wickham, is used to capture student input and to provide immediate feedback relevant to the course material at hand.
swirl leans heavily on exercising a student's use of the R console. A callback
mechanism, suggested and first demonstrated for the purpose by Hadley Wickham,
is used to capture student input and to provide immediate feedback relevant to
the course material at hand.

[swirlify](https://github.com/swirldev/swirlify) is a separate R package that provides a comprehensive toolbox for swirl instructors. Content is authored in [YAML](http://en.wikipedia.org/wiki/YAML) using the handy tools described on the [instructors page](http://swirlstats.com/instructors.html) of our website.
[swirlify](https://github.com/swirldev/swirlify) is a separate R package that
provides a comprehensive toolbox for swirl instructors. Content is authored in
[YAML](http://en.wikipedia.org/wiki/YAML) using the handy tools described on
the [instructors page](http://swirlstats.com/instructors.html) of our website.

The program is initiated with `swirl()`. Functions which control swirl's behavior include `bye()` to quit, `skip()` to skip a question, `main()` to return to the main menu, `play()` to allow experimentation in the R console without interference from swirl, `nxt()` to resume interacting with swirl, and `info()` to display a help menu.
The program is initiated with `swirl()`. Functions which control swirl's
behavior include `bye()` to quit, `skip()` to skip a question, `main()` to
return to the main menu, `play()` to allow experimentation in the R console
without interference from swirl, `nxt()` to resume interacting with swirl, and
`info()` to display a help menu.


## Installing swirl (from CRAN)
Expand All @@ -24,25 +42,34 @@ library(swirl)
swirl()
```

As we continue adding new features and content, we will make new versions available on CRAN as appropriate (every 1-2 months, most likely).
As we continue adding new features and content, we will make new versions
available on CRAN as appropriate (every 1-2 months, most likely).

## Installing the latest development version (from GitHub)

To access the most recent features and content, you can install and run the development version of swirl using the [devtools](https://github.com/hadley/devtools) package:
To access the most recent features and content, you can install and run the
development version of swirl using the [devtools](https://github.com/hadley/devtools) package:

```
install.packages("devtools")
devtools::install_github("swirldev/swirl")
devtools::install_github("swirldev/swirl", ref = "dev")
library(swirl)
swirl()
```

## Contributing to swirl's development

If you'd like to get involved, please fork this repository and submit a pull request with your proposed changes. We're happy to chat if you have any questions about the source code.
If you'd like to get involved, please fork this repository and submit a pull
request with your proposed changes. We're happy to chat if you have any
questions about the source code.

## Using swirl in the classroom

Instructors around the world are using swirl in their classrooms. We think this is awesome. If you're an instructor, please feel free to do the same -- free of charge. While your students may be paying to take your course or attend your institution, we simply ask that you don't charge people *directly* for the use of our software or instructional content.
Instructors around the world are using swirl in their classrooms. We think this
is awesome. If you're an instructor, please feel free to do the same -- free of
charge. While your students may be paying to take your course or attend your
institution, we simply ask that you don't charge people *directly* for the use
of our software or instructional content.

If you are not sure about a particular use case, don't hesitate to send us an email at info@swirlstats.com.
If you are not sure about a particular use case, don't hesitate to send us an
email at info@swirlstats.com.
11 changes: 3 additions & 8 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
## Release summary

This is the first attempted CRAN release of swirl 2.4.1.
This patch is in response to a message from Brian Ripely
informing me that a test fails in the Latin-1 locale, and a
message from Hadley Wickham informing me that the new
version of testthat introduces breaking changes to swirl.
This patch should resolve both of those issues.
This is the first attempted CRAN release of swirl 2.4.2.

## Test environments

* local OSX Yosemite install, R 3.2.4
* Ubuntu 12.04 (on travis-ci), R 3.2.4
* local OSX Yosemite install, R 3.3.0
* Ubuntu 12.04 (on travis-ci), R 3.3.0
* win-builder (devel and release)

## R CMD check results
Expand Down
Binary file modified revdep/checks.rds
Binary file not shown.

0 comments on commit d85769b

Please sign in to comment.