new: Readme

Readme.md

+
+
+<!-- Readme.md is generated from Readme.org. Please edit that file -->
+
+
+# binclaperf R package
+
+This package provides some functionality for easy assessing of
+(binary) classification performance.
+
+## Installation
+
+Installation directly from gitlab is possible, when the package
+[devtools](https://cran.r-project.org/package=devtools) is installed.
+
+Once the dependencies are installed, get this package with
+
+```R
+library("devtools")
+install_git("https://gitlab.gwdg.de/aleha/binclaperf")
+```
+
+## Roadmap
+
+
+<!--
+Local Variables:
+ mode: gfm
+ markdown-command: "marked"
+End:
+-->

Readme.org

+#+TITLE: binclaperf R package
+#+OPTIONS: toc:nil num:nil
+
+
+* Preamble						      :ignoreheading:
+#+md: <!-- Readme.md is generated from Readme.org. Please edit that file -->
+
+#+begin_src emacs-lisp :exports none :results none
+  (defun readmeplot ()
+    ""
+    (file-name-nondirectory (org-babel-temp-file "./Readme-fig-" ".png")))
+#+end_src
+
+
+
+* TOC 							      :ignoreheading:
+# #+TOC: headlines 2
+
+
+* binclaperf R package
+
+This package provides some functionality for easy assessing of
+(binary) classification performance.
+
+
+
+** Example Usage                                                   :noexport:
+
+To be done.
+
+
+** Installation
+
+Installation directly from gitlab is possible, when the package
+[[https://cran.r-project.org/package=devtools][devtools]] is installed.
+
+Once the dependencies are installed, get this package with
+
+#+begin_src R :exports code :eval never
+  library("devtools")
+  install_git("https://gitlab.gwdg.de/aleha/binclaperf")
+#+end_src
+
+
+** Roadmap
+
+
+* Local Variables for the *.md file 			      :ignoreheading:
+
+#+begin_export markdown
+<!--
+Local Variables:
+ mode: gfm
+ markdown-command: "marked"
+End:
+-->
+#+end_export
+
+* Ignore Local Variables above 					   :noexport:
+