diff --git a/.gitignore b/.gitignore index 23a20d4..891da15 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .Rproj.user .DS_Store my_bed.bed +docs diff --git a/README.html b/README.html new file mode 100644 index 0000000..1e4e954 --- /dev/null +++ b/README.html @@ -0,0 +1,425 @@ + + + + +
+ + + + + + + + +This is biomaesteR, an R package with convenience functions commonly +requested in various types of genomic analysis within R. This package is +specialized to provide bioinformatics infrastructure that can be used in +a variety of genomic analysis.
+This repo is also an ongoing project intended for demonstrating and +following best-practices in development of R packages. This includes +adequate package documentation (functions, bundled data objects, etc.), +reproducible unit tests and vignettes. Upon Pull Requests, this repo +also executes a GitAction workflow where the package is installed in +various environments and thorough testing of the complete code base.
+Open R studio and run the following command to install the +development version from GitHub:
+devtools::install_github("mattssca/BioMaesteR")
+MIT License + +Copyright (c) 2023 Carl-Adam Mattsson + +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. ++ +