add logo + update README
Browse files- README.md +15 -1
- docs/ADD_NEW_DATA.md +12 -0
- docs/USE_EXISTING_DATA.md +7 -0
- docs/images/test-datasets_logo.png +0 -0
- docs/images/test-datasets_logo.svg +205 -0
README.md
CHANGED
|
@@ -1,2 +1,16 @@
|
|
| 1 |
-
# test-datasets
|
| 2 |
Test data to be used for automated testing with the nf-core pipelines
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# 
|
| 2 |
Test data to be used for automated testing with the nf-core pipelines
|
| 3 |
+
|
| 4 |
+
## Introduction
|
| 5 |
+
|
| 6 |
+
nf-core is a collection of high quality Nextflow pipelines.
|
| 7 |
+
|
| 8 |
+
## Documentation
|
| 9 |
+
nf-core/test-datasets comes with documentation in the `docs/` directory:
|
| 10 |
+
|
| 11 |
+
01. [Add a new test dataset](https://github.com/nf-core/test-datasets/blob/master/docs/ADD_NEW_DATA.md)
|
| 12 |
+
02. [Use an existing test dataset](https://github.com/nf-core/test-datasets/blob/master/docs/USE_EXISTING_DATA.md)
|
| 13 |
+
|
| 14 |
+
## Support
|
| 15 |
+
|
| 16 |
+
For further information or help, don't hesitate to get in touch on our [Gitter channel](https://gitter.im/nf-core/Lobby)
|
docs/ADD_NEW_DATA.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# How to add and use new test dataset
|
| 2 |
+
|
| 3 |
+
Please fill in the appropriate checklist below (delete whatever is not relevant). These are the most common things requested when adding a new test dataset.
|
| 4 |
+
|
| 5 |
+
- [ ] Check [here](https://github.com/nf-core/test-datasets/branches/all) that there isn't already a branch containing data that could be used
|
| 6 |
+
- If this is the case, follow the [documentation on how to use an existing test dataset](https://github.com/nf-core/test-datasets/blob/master/docs/USE_EXISTING_DATA.md)
|
| 7 |
+
- [ ] Fork the [nf-core/test-datasets repository](https://github.com/nf-core/nf-core/test-datasets) to your GitHub account
|
| 8 |
+
- [ ] Create a new branch on your fork
|
| 9 |
+
- [ ] Add your test dataset
|
| 10 |
+
- [ ] Make a PR on a new branch with a relevant name
|
| 11 |
+
- [ ] Wait for the PR to be merged
|
| 12 |
+
- [ ] Use this newly created branch for your tests
|
docs/USE_EXISTING_DATA.md
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# How to use an existing test dataset
|
| 2 |
+
|
| 3 |
+
Please fill in the appropriate checklist below (delete whatever is not relevant). These are the most common things requested when adding a new test dataset.
|
| 4 |
+
|
| 5 |
+
- [ ] Check [here](https://github.com/nf-core/test-datasets/branches/all) to find the branch corresponding to the test dataset you want to use
|
| 6 |
+
- [ ] Specify in the test.config the path to the files from the test dataset
|
| 7 |
+
- [ ] Set up your CI tests following the nf-core best practices (cf [.travis.yml template](https://github.com/nf-core/tools/blob/dev/nf_core/pipeline-template/{{cookiecutter.pipeline_slug}}/.travis.yml))
|
docs/images/test-datasets_logo.png
ADDED
|
docs/images/test-datasets_logo.svg
ADDED
|
|