Merge pull request #9 from a-thind/text-input

a-thind · web-flow · commit 853db838d735 · 2022-09-16T14:49:16.000+01:00
Update all documentation
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,12 +1,13 @@
 Package: ideogram
-Title: Draws ideograms using ideogram.js
+Title: An interactive ideogram widget displaying chromosome segment annotation 
+  using ideogram.js
 Version: 0.0.0.9000
 Authors@R: 
-    person("First", "Last", , "first.last@example.com", role = c("aut", "cre"),
-           comment = c(ORCID = "YOUR-ORCID-ID"))
-Description: What the package does (one paragraph).
-License: `use_mit_license()`, `use_gpl3_license()` or friends to pick a
-    license
+    person("Anisha", "Thind", , "a.thind@cranfield.ac.uk", role = c("aut", "cre"))
+Description: Ideogram is a wrapper html widget for the IdeogramJS API that 
+  renders an interactive ideogram displaying shared IBD segments parsed from an 
+  input IBD segment file.
+License: MIT + file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.2.1
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,2 @@
+YEAR: 2022
+COPYRIGHT HOLDER: ideogram authors
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2022 ideogram authors
+
+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.
diff --git a/NAMESPACE b/NAMESPACE
@@ -2,6 +2,7 @@
 
 export(ideogram)
 export(ideogramOutput)
+export(readFile)
 export(renderIdeogram)
 import(DescTools)
 import(htmlwidgets)
diff --git a/man/readFile.Rd b/man/readFile.Rd

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+YEAR: 2022`
	`2`	`+COPYRIGHT HOLDER: ideogram authors`