Skip to content

Commit

Permalink
Changes to README before releasing 0.1.0 (#87)
Browse files Browse the repository at this point in the history
* Small changes to README

* Update histogram gif

* Create LICENSE

* Remove GISAID data and update README for license

* Fix bug uncommitted cidgoh logo

* wip
  • Loading branch information
ivansg44 authored Nov 6, 2021
1 parent ccbea32 commit e9e49a5
Show file tree
Hide file tree
Showing 94 changed files with 36 additions and 342,962 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 Centre for Infectious Disease and One Health

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ functional impact, based on Dash & Plotly frameworks.

### 1. Clone the repository and its submodules

`$ git clone git@github.com:cidgoh/COVID-MVP.git --recurse-submodules`
`$ git clone git@github.com:cidgoh/COVID-MVP.git`

### 2. Create a virtual environment

Expand Down Expand Up @@ -110,10 +110,6 @@ frequency.
The clade defining switch allows you to filter in and out heatmap cells
corresponding to non-clade defining mutations.

![editing_viz]

[editing_viz]: screenshots/editing_viz.gif

## Submodules

### [nf-ncov-voc][nf-ncov-voc]
Expand Down Expand Up @@ -151,9 +147,19 @@ isgill93@student.ubc.ca.

William Hsiao, Gary Van Domselaar, and Paul Gordon

The results here are in whole or part based upon data hosted at the Canadian
VirusSeq Data Portal: https://virusseq-dataportal.ca/. We wish to acknowledge
the following organisations/laboratories for contributing data to the Portal:
Canadian Public Health Laboratory Network (CPHLN), CanCOGGeN VirusSeq,
Saskatchewan - Roy Romanow Provincial Laboratory(RRPL), Nova Scotia Health
Authority, Alberta ProvLab North(APLN), Queen's University / Kingston Health
Sciences Centre, National Microbiology Laboratory(NML), BCCDC Public Health
Laboratory, Public Health Ontario(PHO), Newfoundland and Labrador - Eastern
Health, Unity Health Toronto, Ontario Institute for Cancer Research(OICR),
Manitoba Cadham Provincial Laborator, and Manitoba Cadham Provincial Laboratory.

## License

This project currently hosts data that cannot be publicly shared, so we are
currently retaining default copyright laws. We retain all rights to our source
code and no one may reproduce, distribute, or create derivative works from our
work without explicit permission.
[MIT][4]

[4]: LICENSE
Binary file added assets/cidgoh_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

This file was deleted.

This file was deleted.

This file was deleted.

Loading

0 comments on commit e9e49a5

Please sign in to comment.