README.md in nsrr-0.4.0 vs README.md in nsrr-5.0.0.rc
- old
+ new
@@ -1,19 +1,18 @@
# NSRR Ruby Gem
-[](https://travis-ci.org/nsrr/nsrr-gem)
-[](https://gemnasium.com/nsrr/nsrr-gem)
+[](https://travis-ci.com/nsrr/nsrr-gem)
[](https://codeclimate.com/github/nsrr/nsrr-gem)
The official ruby gem built to simplify file downloads and dataset integration tasks for the [National Sleep Research Resource](https://sleepdata.org).
## Prerequisites
-You must have **Ruby 2.2+ installed** on your system to use the NSRR gem.
+You must have **Ruby 2.4+ installed** on your system to use the NSRR gem.
- [Install Ruby on Windows](https://github.com/remomueller/documentation/blob/master/windows/130-ruby.md)
-- [Install Ruby on Mac](https://github.com/remomueller/documentation/blob/master/macosx/130-install-rvm.md)
+- [Install Ruby on Mac](https://github.com/remomueller/documentation/blob/master/macos/130-install-rvm.md)
- [Install Ruby on Linux (CentOS)](https://github.com/remomueller/documentation/blob/master/centos/130-install-rvm.md)
## Installation
The following commands can be run in **Command Prompt** on Windows, and in **Terminal** on Mac OS X.
@@ -22,18 +21,10 @@
```console
gem install nsrr --no-document
```
-**NOTE:** There is a bug in newer versions of RubyGems that prevent the NSRR gem
-from running correctly. If you run into issues, downgrade RubyGems using the
-following command:
-
-```console
-gem update --system 2.4.8 --no-document
-```
-
## Usage
### Download files from a dataset
**Note:** You can type `Ctrl-C` to pause downloads and resume later by retyping the command.
@@ -79,11 +70,11 @@
```console
nsrr console
```
```
-d = Dataset.find 'shhs'
+d = Dataset.find "shhs"
d.download
Get your token here: https://sleepdata.org/token
Your input is hidden while entering token.
Enter your token: AUTHORIZED
File Check: md5
@@ -98,28 +89,28 @@
identical shhs1-dataset-0.6.0.csv
...
```
**method**
- - 'md5' [default]
+ - "md5" [default]
- Checks if a downloaded file exists with the exact md5 as the online version, if so, skips that file
- - 'fresh'
+ - "fresh"
- Downloads every file without checking if it was already downloaded
- - 'fast'
+ - "fast"
- Only checks if a download file exists with the same file size as the online version, if so, skips that file
**depth**
- - 'recursive' [default]
+ - "recursive" [default]
- Downloads files in selected path folder and all subfolders
- - 'shallow'
+ - "shallow"
- Only downloads files in selected path folder
For example to download only the shhs1 edfs folder and skip MD5 file validation:
```
-d = Dataset.find 'shhs'
-d.download('edfs/shhs1', method: 'fast', depth: 'shallow')
+d = Dataset.find "shhs"
+d.download("edfs/shhs1", method: "fast", depth: "shallow")
Get your token here: https://sleepdata.org/token
Your input is hidden while entering token.
Enter your token: AUTHORIZED
File Check: md5
@@ -134,11 +125,11 @@
```
You can type `Ctrl-C` to pause the download, and retype the command to restart:
```
-d = Dataset.find 'shhs'
+d = Dataset.find "shhs"
d.download
Get your token here: https://sleepdata.org/token
Your input is hidden while entering token.
Enter your token: AUTHORIZED
@@ -206,34 +197,5 @@
location the files are being downloaded to (a root directory C: for example).
It is recommended to use the gem without elevated privileges first in any case
(to download directly to Desktop for example) before using admin privileges for
the Ruby gem.
-
-### Issue "'method_missing': undefined method 'this'" when running NSRR commands
-
-There is a bug in newer versions of RubyGems that prevent the NSRR gem
-from running correctly. If you run into issues, downgrade RubyGems using the
-following command:
-
-The following versions of RubyGems cause issues while running NSRR commands:
-
-- `2.5.0`
-- `2.5.1`
-- `2.5.2`
-- `2.6.0`
-- `2.6.1`
-- `2.6.2`
-
-You can check which version you have installed by typing:
-
-```console
-gem -v
-```
-
-You can fix this error by reverting to the last stable version of RubyGems,
-`2.4.8`. Note: RubyGems `2.6.3` also includes a fix to this issue.
-
-```console
-gem update --system 2.4.8 --no-document
-```
-