Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
http://api.brain-map.org/api/v2/data/query.xml?criteria=
service::mouse_connectivity_target_spatial[seed_point$eq6600,5400,4800][start_row$eq25][num_rows$eq50]

service::

...

Parameters

set

String

Data set name: mouse or mouse_coronal.

structures

Array (optional)

Comma delimited list of Structure.id or Structure.acronym.

row

Integer

DataSet.id to correlate against.

sort_order

String (optional)

'asc' or 'desc'. Defaults to 'desc'.

start_row

Integer (optional)

Starting row of data for paging purposes. Defaults to 0.

num_rows

Integer (optional)

Number of rows of data for paging purposes. Defaults to 2000.

Example

Code Block

http://api.brain-map.org/api/v2/data/query.xml?criteria=
service::mouse_correlation[set$eqmouse][row$eq68918934]

http://api.brain-map.org/api/v2/data/query.xml?criteria=
service::mouse_correlation[set$eqmouse_coronal][row$eq357096]

service::mouse_differential

Parameters

set

String

Data set name: mouse or mouse_coronal.

structures1

Array

Comma delimited list of Structure.id.

structures2

Array

Comma delimited list of Structure.id.

threshold1

Array (optional)

Comma delimited Integer pair indicating thresholds for domain 1.

threshold2

Array (optional)

Comma delimited Integer pair indicating thresholds for domain 2.

start_row

Integer (optional)

Starting row of data for paging purposes. Defaults to 0.

num_rows

Integer (optional)

Number of rows of data for paging purposes. Defaults to 2000.

Examples

Code Block

http://api.brain-map.org/api/v2/data/query.xml?criteria=
service::mouse_differential[set$eq'mouse'][structures1$eq8][structures2$eq315]

http://api.brain-map.org/api/v2/data/query.xml?criteria=
service::mouse_differential[set$eq'mouse_coronal'][structures1$eq8][structures2$eq315]

service::nhp_lmd_microarray_correlation

Parameters

donors

Array (optional)

comma separated list of integers Donor ids. Defaults to all donors.

structures

Array

Comma delimited list of Structure.id.

probes

Integer

Probe.id to correlate against.

sort_order

String (optional)

'asc' or 'desc'. Defaults to 'asc'.

start_row

Integer (optional)

starting row of data for paging purposes. Defaults to 0.

num_rows

Integer (optional)

number of rows of data for paging purposes. Defaults to 2000.

Example

Code Block
http://api.brain-map.org/api/v2/data/query.xml?criteria=
service::nhp_lmd_microarray_correlation[probes$eq30357][structures$eqBN]

service::nhp_lmd_microarray_differential

Parameters

donors1

Array (optional)

Comma delimited list of Donor.id. Defaults to all donors.

structures1

Array

Comma delimited list of Structure.id.

donors2

Array (optional)

Comma delimited list of Donor.id. Defaults to all donors.

structures2

Array

Comma delimited list of Structure.id.

sort_by

String (optional)

'p-value' or 'fold-change'. Defaults to 'p-value'.

start_row

Integer (optional)

Starting row of data for paging purposes. Defaults to 0.

num_rows

Integer (optional)

Number of rows of data for paging purposes. Defaults to 2000.

Example

Code Block
http://api.brain-map.org/api/v2/data/query.xml?criteria=
service::nhp_lmd_microarray_differential[structures1$eqHF][structures2$eqBN]

service::nhp_lmd_microarray_expression

Parameters

probes

Integer

Probe.id to correlate against.

start_row

Integer (optional)

Starting row of data for paging purposes. Defaults to 0.

num_rows

Integer (optional)

Number of rows of data for paging purposes. Defaults to 2000.

Example

Code Block
http://api.brain-map.org/api/v2/data/query.xml?criteria=
service::nhp_lmd_microarray_expression[probes$eq15815]

service::nhp_macro_microarray_correlation

Parameters

donors

Array (optional)

Donor.id. Defaults to all donors.

structures

Array

Comma delimited list of Structure.id.

probes

Integer

Probe.id to correlate against.

sort_order

String (optional)

'asc' or 'desc'. Defaults to 'asc'.

start_row

Integer (optional)

Starting row of data for paging purposes. Defaults to 0.

num_rows

Integer (optional)

Number of rows of data for paging purposes. Defaults to 2000.

Example

Code Block
http://api.brain-map.org/api/v2/data/query.xml?criteria=
service::nhp_macro_microarray_correlation[probes$eq49067][structures$eqBN]

service::nhp_macro_microarray_differential

Parameters

donors1

Array (optional)

Donor.id. Defaults to all donors.

structures1

Array

Comma delimited list of Structure.id.

donors2

Array (optional)

Donor.id. Defaults to all donors.

structures2

Array

Comma delimited list of Structure.id.

sort_by

String (optional)

'p-value' or 'fold-change'. Defaults to 'p-value'.

start_row

Integer (optional)

starting row of data for paging purposes. Defaults to 0.

num_rows

Integer (optional)

Number of rows of data for paging purposes. Defaults to 2000.

Examples

Code Block
http://api.brain-map.org/api/v2/data/query.xml?criteria=
service::nhp_macro_microarray_differential[structures1$eqHF][structures2$eqBN]

service::nhp_macro_microarray_expression

Parameters

probes

Integer

Probe.id to correlate against.

start_row

Integer (optional)

Starting row of data for paging purposes. Defaults to 0.

num_rows

Integer (optional)

Number of rows of data for paging purposes. Defaults to 2000.

Example

Code Block
http://api.brain-map.org/api/v2/data/query.xml?criteria=
service::nhp_macro_microarray_expression[probes$eq15815]

Parameters

query_string

String

String to search for (* is a wildcard)

k

String

The model that is the type of object to search for (i.e. Gene)

Example

Code Block
http://api.brain-map.org/api/v2/data/query.xml?criteria=
service::text_search[query_string$eq'abat'][k$eqGene]

...

The output from the previous pipeline stage in json format.

Parameters

(left hand side of parameter)

The variable id to be set in the pipeline namespace.

(right hand side of parameter)

A string using simple path syntax.

...

Code Block
pipe::list[gene_ids$eq'id'][probe_ids$eq'probes/probe/id']

Example

Code Block
http://api.brain-map.org/api/v2/data/query.json?criteria=
model::Organism[name$il'*sapiens'],
pipe::list[xorganism_id$eq'id'],
model::Gene[organism_id$in$xorganism_id]

...

The constant string or variable passed into the input parameter

Parameters

pattern

Regular expression pattern to match against

replacement

String to replace the strings in input that match pattern.

input

Variable obtained from pipe::list or a constant string.

output

Name of a variable to assign the results to.

...

Code Block
pipe::replace[pattern$eq'a'][replacement$eq'b'][input$in'abcd'][output$eqexample]

Example

Code Block
http://api.brain-map.org/api/v2/data/query.json?criteria=
model::Structure[acronym$eq'HiF'][ontology_id$eq7],
pipe::list[path$eq'structure_id_path'],
pipe::replace[pattern$eq'$'][replacement$eq'*'][input$in$path][output$eq'descendents'],
model::Structure[structure_id_path$il$descendents][ontology_id$eq7]

...

The constant string or variable passed into the input parameter

Parameters

pattern

A regular expression pattern to match against.

input

A variable obtained from pipe::list or a constant string.

output

The name of a variable to assign the results to.

...

Code Block
pipe::split[pattern$eq'x'][input$in'axbxcxd'][output$eqexample]

Example

Code Block
http://api.brain-map.org/api/v2/data/query.json?criteria=
model::Structure[acronym$eq'HiF'][ontology_id$eq7],pipe::list[path$eq'structure_id_path'],
pipe::replace[pattern$eq'(^\/)|(\/$)'][replacement$eq''][input$in$path][output$eq'path'],
pipe::split[pattern$eq'/'][input$in$path][output$eq'ancestors'],model::Structure[id$in$ancestors][ontology_id$eq7]

...