highdimInfo: Show information on a high dimensional dataset
In transmart/RInterface: R Client for accessing the tranSMART RESTful API

Description Usage Arguments Details Value Note Author(s) See Also Examples

This function will retrieve and return a nested structure containing the high dimensional data description for a given concept.

1	highdimInfo(study.name = NULL, concept.match = NULL, concept.link = NULL)

You must specify either concept.link or study.name and concept.match.

`study.name`	a character string giving the name of a study.
`concept.match`	a character string containing the concept name that should be matched. The function will search within the requested study for the first concept of which the name matches the given string value. It uses the name column of the result from `getConcepts` to perform the matching.
`concept.link`	a character string containing the link pointing to the location of the data on the server. Candidate values for this argument can be found in `api.link.self.href` column of the `getConcepts` results. It is the most exact way to refer to a concept. If this is specified, `study.name` and `concept.match` are ignored.

This function returns information on a high dimensional data concept. The description retrieved from the server is returned to the caller as-is, so the exact structure depends on the server you are connecting to.

A named list. The first level contains an item for every high dimensional data type that this concept supports. Usually that will be just one.

For every such data type, there is again a list with several names:

`supportedProjections`	A character vector of supported projections for this concept.
`supportedDataConstraints`	A character vector of supported data constraints for this concept.
`supportedAssayConstraints`	A character vector of supported assay constraints for this concept.
`name`	The name of this data type. This is the same as the name of the top level list.
`assayCount`	The number of assays in this data type.
`api.link`	This contains a nested structure with links to related resources. For example there is `self$href` that points to the current resource, and `<projection_name>$href` that is the url for downloading data for that projection.

To be able to access a transmart database, you need to be connected to the server the database is on. If you haven't connected to the server yet, establish a connection using the connectToTransmart function.

Tim Dorscheidt, Jan Kanis, Rianne Jansen. Contact: development@thehyve.nl

hash, getHighdimData, getStudies, getConcepts.

## Not run: 

  # if a concept contains high dimensional data, use the following command to see a description of that data:
  info <- highdimInfo(study.name = "GSE8581", concept.match = "Lung")
  
## End(Not run)