Browse code

- Added a basic Readme file with sticker.

Dario Strbenac authored on 10/11/2022 01:45:05
Showing 2 changed files

1 1
new file mode 100644
... ...
@@ -0,0 +1,25 @@
1
+# ClassifyR: Performance evaluation for multi-view data sets and seamless integration with MultiAssayExperiment and Bioconductor
2
+
3
+<img src="inst/ClassifyRsticker.png" align="right">
4
+
5
+ClassifyR's performance evaluation focuses on model stability and interpretability. Based on repeated cross-validation, it is possible to evaluate feature selection stability and also per-sample prediction accuracy. Also, multiple omics data assays on the same samples are becoming more popular and ClassifyR supports a range of multi-view methods to evaluate which data view is the most predictive and combine data views to evaluate if multiple views provide superior predictive performance to a single data view.
6
+
7
+##  Installation 
8
+
9
+The recommended method of installing ClassifyR is by using Bioconductor's BiocManager installer:
10
+
11
+```
12
+library(BiocManager)
13
+install("ClassifyR", dependencies = TRUE)
14
+```
15
+
16
+The above code will install all packages that provide feature selection or model-building functionality. If only one or two methods are desired then the dependencies option could be omitted and those packages providing functionality installed manually. 
17
+ 
18
+##  Website
19
+
20
+Please visit [the ClassifyR website](https://sydneybiox.github.io/ClassifyR/) to view the main vignette as well as articles that provide more in-depth explanations for various aspects of the package. Details of performance evaluation, multi-view methods and contributing a wrapper for a new algorithm to the package are provided.
21
+
22
+
23
+## Reference
24
+
25
+Strbenac D., Mann, G.J., Ormerod, J.T., and Yang, J. Y. H. (2015) ClassifyR: An R package for performance assessment of classification with applications to transcriptomics, *Bioinformatics*.
0 26
new file mode 100644
1 27
Binary files /dev/null and b/inst/ClassifyRsticker.png differ