/
pc_sect.Rd
75 lines (72 loc) · 2.72 KB
/
pc_sect.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/pubchem.R
\name{pc_sect}
\alias{pc_sect}
\title{Retrieve data from PubChem content pages}
\usage{
pc_sect(
id,
section,
domain = c("compound", "substance", "assay", "gene", "protein", "patent"),
verbose = TRUE
)
}
\arguments{
\item{id}{numeric or character; a vector of PubChem identifiers to search
for.}
\item{section}{character; the section of the content page to be imported.}
\item{domain}{character; the query domain. Can be one of \code{"compound"},
\code{"substance"}, \code{"assay"}, \code{"gene"}, \code{"protein"} or
\code{"patent"}.}
\item{verbose}{logical; should a verbose output be printed on the console?}
}
\value{
Returns a tibble of query results. In the returned tibble,
\code{SourceName} is the name of the depositor, and \code{SourceID} is the
ID of the search term within the depositor's database. You can browse
\url{https://pubchem.ncbi.nlm.nih.gov/sources/} for more information about
the depositors.
}
\description{
When you search for an entity at \url{https://pubchem.ncbi.nlm.nih.gov/},
e.g. a compound or a substance, and select the record you are interested in,
you will be forwarded to a PubChem content page. When you look at a PubChem
content page, you can see that chemical information is organised into
sections, subsections, etc. The chemical data live at the lowest levels of
these sections. Use this function to retrieve the lowest level information
from PubChem content pages.
}
\details{
\code{section} is not case sensitive but it is sensitive to typing
errors and it requires the full name of the section as it is printed on the
content page. The PubChem Table of Contents Tree can also be found at
\url{https://pubchem.ncbi.nlm.nih.gov/classification/#hid=72}.
}
\note{
Please respect the Terms and Conditions of the National Library of
Medicine, \url{https://www.nlm.nih.gov/databases/download.html} the data
usage policies of National Center for Biotechnology Information,
\url{https://www.ncbi.nlm.nih.gov/home/about/policies/},
\url{https://pubchemdocs.ncbi.nlm.nih.gov/programmatic-access}, and the data
usage policies of the individual data sources
\url{https://pubchem.ncbi.nlm.nih.gov/sources/}.
}
\examples{
# might fail if API is not available
\donttest{
pc_sect(176, "pka")
pc_sect(c(176, 311), "density")
pc_sect(2231, "depositor-supplied synonyms", "substance")
pc_sect(780286, "modify date", "assay")
pc_sect(9023, "Ensembl ID", "gene")
pc_sect("1ZHY_A", "Sequence", "protein")
}
}
\references{
Kim, S., Thiessen, P.A., Cheng, T. et al. PUG-View: programmatic
access to chemical annotations integrated in PubChem. J Cheminform 11, 56
(2019). \doi{10.1186/s13321-019-0375-2}.
}
\seealso{
\code{\link{get_cid}}, \code{\link{pc_prop}}
}