Browse code

update vignette, new datasets

Simone authored on 18/05/2021 20:04:54
Showing 1 changed files
... ...
@@ -26,9 +26,6 @@ schemaName available are:
26 26
 }
27 27
 if schemaName is NULL, it looks for a XML schema file to read in the 
28 28
 folderPath}
29
-
30
-\item{isGMQL}{logical value indicating whether it is uploaded a GMQL 
31
-dataset or not}
32 29
 }
33 30
 \value{
34 31
 None
Browse code

update RD

Simone authored on 27/03/2021 15:11:43
Showing 1 changed files
... ...
@@ -41,6 +41,21 @@ a new dataset is created on remote repository
41 41
 \details{
42 42
 If no error occurs, it prints "Upload Complete", otherwise a specific error 
43 43
 is printed
44
+
45
+NOTE: 
46
+The folder layout must obey the following rules and adopt 
47
+the following layout:
48
+The dataset folder can have any name, but must contains the 
49
+sub-folders named: "files".
50
+The sub-folder "files" contains the dataset files and 
51
+the schema xml file.
52
+The schema files adopt the following the naming conventions:
53
+
54
+- "schema.xml"
55
+- "test.schema"
56
+
57
+The names must be in LOWERCASE. Any other schema file 
58
+will not be conisdered, if both are present, "test.schema" will be used.
44 59
 }
45 60
 \examples{
46 61
 
Browse code

update with some news

Simone authored on 21/03/2021 14:34:30
Showing 1 changed files
1 1
old mode 100644
2 2
new mode 100755
... ...
@@ -4,7 +4,7 @@
4 4
 \alias{upload_dataset}
5 5
 \title{Upload dataset}
6 6
 \usage{
7
-upload_dataset(url, datasetName, folderPath, schemaName = NULL, isGMQL = TRUE)
7
+upload_dataset(url, datasetName, folderPath, schemaName = NULL)
8 8
 }
9 9
 \arguments{
10 10
 \item{url}{string url of server: It must contain the server address 
Browse code

fix take and read

Simone authored on 09/02/2021 09:07:32
Showing 1 changed files
... ...
@@ -4,8 +4,7 @@
4 4
 \alias{upload_dataset}
5 5
 \title{Upload dataset}
6 6
 \usage{
7
-upload_dataset(url, datasetName, folderPath, schemaName = NULL,
8
-  isGMQL = TRUE)
7
+upload_dataset(url, datasetName, folderPath, schemaName = NULL, isGMQL = TRUE)
9 8
 }
10 9
 \arguments{
11 10
 \item{url}{string url of server: It must contain the server address 
Browse code

fixed url

Simone authored on 16/08/2018 09:03:55
Showing 1 changed files
... ...
@@ -54,7 +54,7 @@ test_path <- system.file("example", "DATASET_GDM", package = "RGMQL")
54 54
 
55 55
 ## Login to GMQL REST services suite at remote url
56 56
 
57
-remote_url <- "http://genomic.deib.polimi.it/gmql-rest-r/"
57
+remote_url <- "http://www.gmql.eu/gmql-rest/"
58 58
 login_gmql(remote_url)
59 59
 
60 60
 ## Upload of GMQL dataset with "dataset1" as name, without specifying any 
Simone authored on 19/01/2018 11:06:58
Showing 1 changed files
... ...
@@ -25,7 +25,7 @@ schemaName available are:
25 25
 \item{BED}
26 26
 \item{BEDGRAPH}
27 27
 }
28
-if schemaName is NULL it's looking for a XML schema file to read in the 
28
+if schemaName is NULL, it looks for a XML schema file to read in the 
29 29
 folderPath}
30 30
 
31 31
 \item{isGMQL}{logical value indicating whether it is uploaded a GMQL 
... ...
@@ -52,12 +52,12 @@ is printed
52 52
 
53 53
 test_path <- system.file("example", "DATASET_GDM", package = "RGMQL")
54 54
 
55
-## login to GMQL REST services suite at remote url
55
+## Login to GMQL REST services suite at remote url
56 56
 
57 57
 remote_url <- "http://genomic.deib.polimi.it/gmql-rest-r/"
58 58
 login_gmql(remote_url)
59 59
 
60
-## upload of GMQL dataset with "dataset1" as name without specifying any 
60
+## Upload of GMQL dataset with "dataset1" as name, without specifying any 
61 61
 ## schema 
62 62
 
63 63
 upload_dataset(remote_url, "dataset1", folderPath = test_path)
Browse code

minor fix

Simone authored on 11/01/2018 13:10:15
Showing 1 changed files
... ...
@@ -25,7 +25,8 @@ schemaName available are:
25 25
 \item{BED}
26 26
 \item{BEDGRAPH}
27 27
 }
28
-if schemaName is NULL it's looking for a XML schema file to read}
28
+if schemaName is NULL it's looking for a XML schema file to read in the 
29
+folderPath}
29 30
 
30 31
 \item{isGMQL}{logical value indicating whether it is uploaded a GMQL 
31 32
 dataset or not}
Simone authored on 10/12/2017 16:29:05
Showing 1 changed files
... ...
@@ -11,11 +11,12 @@ upload_dataset(url, datasetName, folderPath, schemaName = NULL,
11 11
 \item{url}{string url of server: It must contain the server address 
12 12
 and base url; service name is added automatically}
13 13
 
14
-\item{datasetName}{name of dataset to get}
14
+\item{datasetName}{name of dataset to create in repository}
15 15
 
16
-\item{folderPath}{string local path to the folder containing the samples}
16
+\item{folderPath}{string local path to the folder containing the samples 
17
+files}
17 18
 
18
-\item{schemaName}{string name of schema used to parse the samples
19
+\item{schemaName}{string name of schema used to parse the samples;
19 20
 schemaName available are:
20 21
 \itemize{
21 22
 \item{NARROWPEAK}
... ...
@@ -24,9 +25,10 @@ schemaName available are:
24 25
 \item{BED}
25 26
 \item{BEDGRAPH}
26 27
 }
27
-if schema is NULL it's looking for a XML schema file to read}
28
+if schemaName is NULL it's looking for a XML schema file to read}
28 29
 
29
-\item{isGMQL}{logical value indicating whether is GMQL dataset or not}
30
+\item{isGMQL}{logical value indicating whether it is uploaded a GMQL 
31
+dataset or not}
30 32
 }
31 33
 \value{
32 34
 None
... ...
@@ -34,20 +36,30 @@ None
34 36
 \description{
35 37
 It uploads a folder (GMQL or not) containing sample files using 
36 38
 the proper GMQL web service available on a remote server: 
37
-a new dataset is created on repository
39
+a new dataset is created on remote repository
38 40
 }
39 41
 \details{
40
-If no error occures print "Upload Complete", otherwise a specific error 
42
+If no error occurs, it prints "Upload Complete", otherwise a specific error 
41 43
 is printed
42 44
 }
43 45
 \examples{
44 46
 
45 47
 \dontrun{
46 48
 
47
-### upload of GMQL dataset with no schema selection
49
+## This statement defines the path to the folder "DATASET_GDM" in the 
50
+## subdirectory "example" of the package "RGMQL"
51
+
48 52
 test_path <- system.file("example", "DATASET_GDM", package = "RGMQL")
49
-remote_url <- "http://genomic.elet.polimi.it/gmql-rest-r/"
53
+
54
+## login to GMQL REST services suite at remote url
55
+
56
+remote_url <- "http://genomic.deib.polimi.it/gmql-rest-r/"
50 57
 login_gmql(remote_url)
58
+
59
+## upload of GMQL dataset with "dataset1" as name without specifying any 
60
+## schema 
61
+
51 62
 upload_dataset(remote_url, "dataset1", folderPath = test_path)
63
+
52 64
 }
53 65
 }
Browse code

clean files and folder

Simone authored on 21/11/2017 13:43:55
Showing 1 changed files
... ...
@@ -1,5 +1,5 @@
1 1
 % Generated by roxygen2: do not edit by hand
2
-% Please edit documentation in R/datasetOp.R
2
+% Please edit documentation in R/web-services.R
3 3
 \name{upload_dataset}
4 4
 \alias{upload_dataset}
5 5
 \title{Upload dataset}
... ...
@@ -46,9 +46,8 @@ is printed
46 46
 
47 47
 ### upload of GMQL dataset with no schema selection
48 48
 test_path <- system.file("example", "DATASET_GDM", package = "RGMQL")
49
-remote_url <- "http://130.186.13.219/gmql-rest"
49
+remote_url <- "http://genomic.elet.polimi.it/gmql-rest-r/"
50 50
 login_gmql(remote_url)
51 51
 upload_dataset(remote_url, "dataset1", folderPath = test_path)
52 52
 }
53
-
54 53
 }
Browse code

S4 methods

Simone authored on 14/11/2017 15:58:33
Showing 1 changed files
... ...
@@ -5,7 +5,7 @@
5 5
 \title{Upload dataset}
6 6
 \usage{
7 7
 upload_dataset(url, datasetName, folderPath, schemaName = NULL,
8
-    isGMQL = TRUE)
8
+  isGMQL = TRUE)
9 9
 }
10 10
 \arguments{
11 11
 \item{url}{string url of server: It must contain the server address 
Browse code

start new build

Simone authored on 10/11/2017 09:12:05
Showing 1 changed files
... ...
@@ -5,7 +5,7 @@
5 5
 \title{Upload dataset}
6 6
 \usage{
7 7
 upload_dataset(url, datasetName, folderPath, schemaName = NULL,
8
-  isGMQL = TRUE)
8
+    isGMQL = TRUE)
9 9
 }
10 10
 \arguments{
11 11
 \item{url}{string url of server: It must contain the server address 
Browse code

change function name, completed vignette and descrption

Simone authored on 08/11/2017 13:30:29
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,54 @@
1
+% Generated by roxygen2: do not edit by hand
2
+% Please edit documentation in R/datasetOp.R
3
+\name{upload_dataset}
4
+\alias{upload_dataset}
5
+\title{Upload dataset}
6
+\usage{
7
+upload_dataset(url, datasetName, folderPath, schemaName = NULL,
8
+  isGMQL = TRUE)
9
+}
10
+\arguments{
11
+\item{url}{string url of server: It must contain the server address 
12
+and base url; service name is added automatically}
13
+
14
+\item{datasetName}{name of dataset to get}
15
+
16
+\item{folderPath}{string local path to the folder containing the samples}
17
+
18
+\item{schemaName}{string name of schema used to parse the samples
19
+schemaName available are:
20
+\itemize{
21
+\item{NARROWPEAK}
22
+\item{BROADPEAK}
23
+\item{VCF}
24
+\item{BED}
25
+\item{BEDGRAPH}
26
+}
27
+if schema is NULL it's looking for a XML schema file to read}
28
+
29
+\item{isGMQL}{logical value indicating whether is GMQL dataset or not}
30
+}
31
+\value{
32
+None
33
+}
34
+\description{
35
+It uploads a folder (GMQL or not) containing sample files using 
36
+the proper GMQL web service available on a remote server: 
37
+a new dataset is created on repository
38
+}
39
+\details{
40
+If no error occures print "Upload Complete", otherwise a specific error 
41
+is printed
42
+}
43
+\examples{
44
+
45
+\dontrun{
46
+
47
+### upload of GMQL dataset with no schema selection
48
+test_path <- system.file("example", "DATASET_GDM", package = "RGMQL")
49
+remote_url <- "http://130.186.13.219/gmql-rest"
50
+login_gmql(remote_url)
51
+upload_dataset(remote_url, "dataset1", folderPath = test_path)
52
+}
53
+
54
+}