GET /api/v1/priors

GET /api/beta/priors

Get all rows that match the values provided for all column-name parameters used. If the value starts with a tilde ('~'), the rest of the value is treated as a regular expression to match and the matching is case insensitive. Otherwise, the column value must match the parameter value exactly.

Params

Param name Description
limit
optional

Sets an upper bound on the number of results to return. Defaults to 200.

Validations:

  • Must match regular expression /^([1-9][0-9]*|all|none)$/.

offset
optional

Set the number of rows to skip before returning matching rows.

Validations:

  • Must match regular expression /[1-9][0-9]*/.

key
optional

The API key to use for authorization.

associations_mode
optional

Set the amount of data to display about associations. Default is “full_info” for the show action and “count” for the index action.

Validations:

  • Must be one of: full_info, ids, count.

id
optional
citation_id
optional
variable_id
optional
phylogeny
optional

Used to note the group of plants for which the prior was specified, often the group of plants represented by the data used to specify the prior.

distn
optional

Name of the probability distribution, using R naming convention (e.g. 'beta','f', 'gamma', 'lnorm', 'norm', 'pois', 't', 'unif', 'weibull'.

parama
optional

First parameter for distribution, as specified by R.

paramb
optional

Second parameter for distribution, as specified by R.

paramc
optional

A third parameter, if required.

n
optional

number of observations used to specify prior.

notes
optional
created_at
optional
updated_at
optional

GET /api/v1/priors/:id

GET /api/beta/priors/:id

Get all information about the row with the matching id value. Information about associated rows (those reference by foreign keys) is shown as well.

Params

Param name Description
key
optional

The API key to use for authorization.

associations_mode
optional

Set the amount of data to display about associations. Default is “full_info” for the show action and “count” for the index action.

Validations:

  • Must be one of: full_info, ids, count.