Merge pull request #7 from mattssca/dev_branch

Update package documentation
mattssca · Jan 9, 2024 · 3c2bbce · 3c2bbce
2 parents 661a775 + 1a7d441
commit 3c2bbce
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,14 +1,14 @@
 Package: BioMaesteR
 Type: Package
-Title: A pacakge with convenience functions for generic genomic analysis within R
+Title: A package with convenience functions for generic genomic analysis within R
 Version: 0.1.0
 Authors@R: person(given = "Adam",
            family = "Mattsson",
            role = c("aut", "cre"),
            email = "[email protected]",
            comment = c(ORCID = "0000-0002-6318-7912"))
 Maintainer: The package maintainer <[email protected]>
-Description: Standardized, genric functions as well as bundeld data objects that can be called in various settings in the scope of biological analysis in R. This package is specialized to provide bioinformatics infrastructure that can be used in a variety of analysis.
+Description: Standardized, generic functions as well as bundeld data objects that can be called in various settings in the scope of biological analysis in R. This package is specialized to provide bioinformatics infrastructure that can be used in a variety of analysis.
 License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true

diff --git a/README.md b/README.md
@@ -1 +1,6 @@
-# BioMaesteR
+# BioMaesteR
+A package with convenience functions for generic genomic analysis within R. 
+Standardized, generic functions as well as bundled data objects that can be 
+called in various settings in the scope of biological analysis in R. 
+This package is specialized to provide bioinformatics infrastructure that can be 
+used in a variety of analysis.