Browse code

Update README.md

SilviaC7 authored on 21/07/2021 13:06:42 • GitHub committed on 21/07/2021 13:06:42
Showing1 changed files

... ...
@@ -3,6 +3,13 @@ API for calling interactively the GMQL Engine from R-Bioconductor
3 3
 
4 4
 [RGMQL on Bioconductor](https://www.bioconductor.org/packages/release/bioc/html/RGMQL.html)
5 5
 
6
+## About
7
+
8
+RGMQL is a R/Bioconductor package conceived to provide a set of specialized functions to extract, combine, process
9
+and compare omics datasets and their metadata from different and differently localized sources. 
10
+RGMQL is built over the GenoMetric Query Language (GMQL) data management and computational engine, and can leverage its open curated
11
+repository as well as its cloud-based resources, with the possibility of outsourcing computational tasks to GMQL remote services. Furthermore, it overcomes the limits of the GMQL declarative syntax, by guaranteeing a procedural approach in dealing with omics data within the R/Bioconductor environment. But mostly, it provides full interoperability with other packages of the R/Bioconductor framework and extensibility over the most used genomic data structures and processing functions.
12
+
6 13
 ## Requirements
7 14
 
8 15
 The library requires the following:
... ...
@@ -33,7 +40,7 @@ RGMQL/
33 40
 |-- README.md
34 41
 ```
35 42
 
36
-- [Example of workflows](Example%20of%20workflows)/ folder containig various use cases
43
+- [Examples of workflows](Example%20of%20workflows)/ folder containing various use cases
37 44
 - [R](R)/ folder containing all the script files
38 45
 - [inst](inst)/ folder containing all files that should be copied into the installed R package folder.
39 46
 - [inst/example](inst/example) folder containing the datasets and other files in order to run correctly all the test.
... ...
@@ -41,12 +48,13 @@ RGMQL/
41 48
 - [man](man)/ folder containing R documentation files
42 49
 - [vignettes](vignettes)/ folder containing all the files used to generate correctly the vignette
43 50
 - [vignettes/RGMQL-vignette.R](vignettes/RGMQL-vignette.R) long-form guide to your package
44
-- [vignettes/RGMQL-vignette.Rmd](vignettes/RGMQL-vignette.Rmd) the vignettes in markup language
45
-- [vignettes/RGMQL-vignette.html](vignettes/RGMQL-vignette.html) the vignettes in html
46
-- [vignettes/bibliography.bib](vignettes/bibliography.bib) the bibliographic or list of reference file used in vignette
47
-- [vignettes/american-medical-association-no-et-al.csl](vignettes/american-medical-association-no-et-al.csl) the citation style language used in vignette
48
-- [DESCRIPTION](DESCRIPTION) this file store important/mandatory metadata about RGMQL package.
49
-- [NAMESPACE](NAMESPACE) this file make your packages self-contained, ensuring that other packages won’t interfere with your code, that your code won’t interfere with other packages, and that your package works regardless of the environment in which it’s run.
51
+- [vignettes/RGMQL-vignette.Rmd](vignettes/RGMQL-vignette.Rmd) vignettes in markup language
52
+- [vignettes/RGMQL-vignette.html](vignettes/RGMQL-vignette.html) vignettes in html
53
+- [vignettes/bibliography.bib](vignettes/bibliography.bib) the bibliographic file with list of references used in vignettes
54
+- [vignettes/american-medical-association-no-et-al.csl](vignettes/american-medical-association-no-et-al.csl) the citation style language used in vignettes
55
+- [DESCRIPTION](DESCRIPTION) this file stores important/mandatory metadata about RGMQL package.
56
+- [NAMESPACE](NAMESPACE) this file makes your packages self-contained, ensuring that other packages do not interfere with your code, that your code does not interfere with other packages, and that your package works regardless of the environment in which it is running.
57
+- [README](README.md) the current file
50 58
 
51 59
 
52 60
 ## OSX Settings