summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'README.g-cran')
-rw-r--r--README.g-cran12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.g-cran b/README.g-cran
new file mode 100644
index 0000000..b5be64e
--- /dev/null
+++ b/README.g-cran
@@ -0,0 +1,12 @@
+==ABOUT==
+G-CRAN is a package which is used to install packages from CRAN-style (Central R Archive Network) repositories, that is, from R package repositories. R, in turn, is a language used for statistical and biocomputational research and development. Hence, there are also two repositories alongside CRAN called the Bioconductor repositories, which contain biological code and data.
+
+==USAGE==
+To use G-CRAN, you need to use g-common, or, if your package manager has integrated g-common support, whatever system your package manager uses. Simply install G-CRAN (note that G-CRAN depends on R) and g-common, and use g-common as described in its documentation.
+
+==EXAMPLE REPOSITORIES==
+Some supported repositories include:
+- CRAN: http://cran.r-project.org/
+- Bioconductor code: http://bioconductor.org/packages/devel/bioc
+- Bioconductor annotation: http://bioconductor.org/packages/devel/data/annotation
+Please note that the Bioconductor annotation repository depends on the code repository, so please install both if you'd like to use the Bioconductor databases.