Merge branch 'main' of github.com:telatin/bamtocov into main

CITATION.cff

@@ -0,0 +1,58 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: >-
+  BamToCov, an efficient toolkit for sequence
+  coverage calculations
+message: >-
+  Please cite this dataset using the metadata from
+  'preferred-citation'.
+type: software
+authors:
+  - given-names: Andrea
+    family-names: Telatin
+    email: [email protected]
+    affiliation: Quadram Institute Bioscience
+    orcid: 'https://orcid.org/0000-0001-7619-281X'
+  - given-names: Giovanni
+    family-names: Birolo
+    email: [email protected]
+    affiliation: University of Turin
+identifiers:
+  - type: doi
+    value: 10.1101/2021.11.12.466787
+    description: >-
+      BamToCov: an efficient toolkit for sequence
+      coverage calculations
+url: 'https://telatin.github.io/bamtocov/'
+abstract: >
+  Motivation: Many genomics applications require the
+  computation of nucleotide coverage of a reference
+  genome or the ability to determine how many reads
+  map to a reference region. 
+
+
+  Results: BamToCov is a toolkit for rapid and
+  flexible coverage computation that relies on a
+  memory efficient algorithm and is designed for
+  integration in pipelines; this is possible as a
+  result of reading alignment files from streams. The
+  tools in the suite can process sorted BAM or CRAM
+  files, allowing the user to extract coverage
+  information via different filtering approaches and
+  also save the output in different formats (BED, Wig
+  or counts). 
+
+  The BamToCov algorithm can also handle
+  strand-specific and/or physical coverage analyses.
+
+
+  Availability: This program, accessory utilities,
+  and their documentation are freely available at
+  https://github.com/telatin/BamToCov.
+keywords:
+  - bioinformatics
+  - sequence coverage
+  - next-generation sequencing
+license: MIT

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contributing to `bamtocov`
+
+## Pull Requests
+If you wish to fix a bug or add new features to the software we welcome **Pull Requests**. 
+We use [GitHub Flow style development](https://guides.github.com/introduction/flow/). 
+
+Please fork the repo, make the change, then submit a Pull Request against out master branch, with details about what the change is and what it fixes/adds. 
+We will then review your changes and merge them, or provide feedback on enhancements.
+
+## Issues
+If you find bugs, or if you would like to make suggestions or feature requests, feel free to open an [issue](https://github.com/telatin/bamtocov/issues).