# R/data.R In AllenInstitute/hbadata: Human Brain Atlas Expression Data

#    Copyright (C) 2017 Allen Institute
#
#    This program is free software; you can redistribute it and/or modify
#    the Free Software Foundation; either version 2 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License along
#    with this program; if not, write to the Free Software Foundation, Inc.,
#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

#'Micro RNA Expression Values for the Human Brain Atlas.
#'
#'A dataset containing the normalized expression values for a single brain in the human brain atlas.
#'
#'
#'@format A data frame with 26013983 rows and 4 variables:
#'\describe{
#'  \item{donorID}{brain ID from the Allen Institute}
#'  \item{gene}{gene the above probe corresponds to; gene to probe is many to one}
#'  \item{brain_structure}{brain structure acronym}
#'  \item{value}{normalized expression value}
#'}
#'
"datHBA.donor1"

#'Micro RNA Expression Values for the Human Brain Atlas.
#'
#'A dataset containing the normalized expression values for a single brain in the human brain atlas.
#'
#'@format A data frame with 10574553 rows and 4 variables:
#'\describe{
#'  \item{donorID}{brain ID from the Allen Institute}
#'  \item{gene}{gene the above probe corresponds to; gene to probe is many to one}
#'  \item{brain_structure}{brain structure acronym}
#'  \item{value}{normalized expression value}
#'}
#'
"datHBA.donor2"

#'Micro RNA Expression Values for the Human Brain Atlas.
#'
#'A dataset containing the normalized expression values for a single brain in the human brain atlas.
#'
#'@format A data frame with 15410299 rows and 4 variables:
#'\describe{
#'  \item{donorID}{brain ID from the Allen Institute}
#'  \item{gene}{gene the above probe corresponds to; gene to probe is many to one}
#'  \item{brain_structure}{brain structure acronym}
#'  \item{value}{normalized expression value}
#'}
#'
"datHBA.donor3"

#'Micro RNA Expression Values for the Human Brain Atlas.
#'
#'A dataset containing the normalized expression values for a single brain in the human brain atlas.
#'
#'@format A data frame with 13691570 rows and 4 variables:
#'\describe{
#'  \item{donorID}{brain ID from the Allen Institute}
#'  \item{gene}{gene the above probe corresponds to; gene to probe is many to one}
#'  \item{brain_structure}{brain structure acronym}
#'  \item{value}{normalized expression value}
#'}
#'
"datHBA.donor4"

#'Micro RNA Expression Values for the Human Brain Atlas.
#'
#'A dataset containing the normalized expression values for a single brain in the human brain atlas.
#'
#'@format A data frame with 14594631 rows and 4 variables:
#'\describe{
#'  \item{donorID}{brain ID from the Allen Institute}
#'  \item{gene}{gene the above probe corresponds to; gene to probe is many to one}
#'  \item{brain_structure}{brain structure acronym}
#'  \item{value}{normalized expression value}
#'}
#'
"datHBA.donor5"

#'Micro RNA Expression Values for the Human Brain Atlas.
#'
#'A dataset containing the normalized expression values for a single brain in the human brain atlas.
#'
#'@format A data frame with 27557926 rows and 4 variables:
#'\describe{
#'  \item{donorID}{brain ID from the Allen Institute}
#'  \item{gene}{gene the above probe corresponds to; gene to probe is many to one}
#'  \item{brain_structure}{brain structure acronym}
#'  \item{value}{normalized expression value}
#'}
#'
"datHBA.donor6"

#'Donor ID's for Brains in the Human Brain Atlas
#'
#'A vector of the donor ID's from the 6 brains in the human brain atlas
#'
#'@format A character vector of length 6:
#'
#'
"donorsHBA"

#'Genes Surveyed in the Human Brain Atlas
#'
#'A list of the genes surved in the Human Brain Atlas at the Allen Institute
#'
#'@format A large character vector of length 29131
#'
"genesHBA"

#'Ontology of the Human Brains in the Human Brain Atlas
#'
#'A dataset containing the acronyms and corresponding structure names for all of the brain structures featured in the Human Brain Atlas.
#'
#'@format A data frame with 559 rows and 2 variables:
#'\describe{
#'  \item{acronyms}{brain structure acronym as used in subregionsHBA}
#'  \item{name}{brain structure names; substructures may have same acronyms}
#'}
#'
"ontologyHBA"

#'mRNA Probes Used in the Human Brain Atlas
#'
#'A list of the mRNA probes surveyed in the Human Brain Atlas at the Allen Institute.
#'
#'@format A large character vector of length 58692