psygenetDisease {psygenet2r} | R Documentation

## Query PsyGeNET for given disease(s) and generates an `DataGeNET.Psy`

### Description

Given the name of one or multiple diseases and retrives their information from PsyGeNET and creates an object of type `DataGeNET.Psy`.

### Usage

    psygenetDisease(
      disease,
      database = "ALL",
      evidenceIndex = c(">", 0),
      verbose = FALSE,
      warnings = TRUE
    )

### Arguments

`disease` | Name or vector of names (that can be both code or uml) to specific diseases from PsyGeNET. The diseases non existing in PsyGeNET will be removed from the output.
`database` | Name of the database that will be queried. It can take the values `'psycur15'` to use data validated by experts for first release of PsyGeNET; `'psycur16'` to use data validated by experts for second release of PsyGeNET; or `'ALL'` to use both databases. Default `'ALL'`.
`evidenceIndex` | A vector with two elements: 1) character with greather `'>'` or with lower `'<'` meaing greather or equal and lower or equal; 2) the evidence index cut-off to be compared. By default: `c('>', 0)`.
`verbose` | By default `FALSE`. Change it to `TRUE` to get a on-time log from the function.
`warnings` | By default `TRUE`. Change it to `FALSE` to don't see the warnings.

### Value

An object of class `DataGeNET.Psy`

### Note

The "Evidence Index" is gotten from PsyGeNET. For more information about it and its calculation, pease visit `psygenet.org`.

### Examples

    d.sch <- psygenetDisease( "schizophrenia", "ALL" )

[Package psygenet2r version 1.22.5 Index]