create_batch_body: Create POST request Body for batch search

Description Usage Arguments Value Author(s) Examples

View source: R/create_batch_body.R

Description

create_batch_body returns a string of a POST request body.

Usage

1
2
3
4
create_batch_body(metabolites_type = "all-except-peptides",
  databases = "[\"all-except-mine\"]", masses_mode = "mz",
  ion_mode = "positive", adducts = "[\"M+H\",\"M+Na\"]",
  tolerance = 10, tolerance_mode = "ppm", unique_mz)

Arguments

metabolites_type

"all-except-peptides", "only-lipids", "all-including-peptides"

databases

"all", "all-except-mine", "HMDB", "LipidMaps", "Metlin", "Kegg", "in-house", "mine"

masses_mode

"neutral", "mz"

ion_mode

"positive", "negative"

adducts

for positive mode [M+H, M+2H, M+Na, M+K,M+NH4, M+H-H2O]

tolerance

double (Range: [0..100])

tolerance_mode

"ppm", "mDa"

unique_mz

An array of unique m/zs

Value

If all inputs are all correctly formatted, a string of a POST request will be returned for the result.

Author(s)

Yaoxiang Li yl814@georgetown.edu

Georgetown University, USA

License: GPL (>= 3)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
batch_body <- create_batch_body('all-except-peptides',
                                '["all-except-mine"]',
                                'mz',
                                'positive',
                                '["M+H","M+Na"]',
                                10,
                                'ppm',
                                c(670.4623, 1125.2555, 602.6180))

batch_body <- create_batch_body('all-except-peptides',
                                '["all-except-mine"]',
                                'mz',
                                'negative',
                                '["M-H","M+Cl"]',
                                10,
                                'ppm',
                                c(670.4623, 1125.2555, 602.6180))

## Not run: 
create_batch_body(c(670.4623, 1125.2555, 602.6180))

## End(Not run)

lzyacht/cmmr documentation built on July 1, 2021, 5:19 p.m.