scopus_has_key: Locate the 'Scopus' API key and institutional token
In scopusflow: A Reproducible Workflow Layer for 'Scopus' Bibliographic Searches
scopus_has_key R Documentation
Locate the 'Scopus' API key and institutional token
Description
scopus_has_key() reports whether an API key can be found, without revealing
it. The key itself is resolved internally and is never printed by the
package.
Usage
scopus_has_key()
Details
The key is looked up first from the api_key argument of whichever function
is being called, then from the scopusflow.api_key option, and finally from
the SCOPUS_API_KEY environment variable. An optional institutional token,
used for off-campus access to subscriber content, is resolved the same way
from the inst_token argument, the scopusflow.inst_token option, or the
SCOPUS_INST_TOKEN environment variable.
A key is a secret. The safest home for it is ~/.Renviron, as in
SCOPUS_API_KEY=xxxx, rather than a script, and it should stay out of version
control.
Value
A length-one logical that is safe to print, TRUE when a non-empty
key is available and FALSE otherwise.
See Also
scopus_count(), scopus_fetch()
Examples
# Does the current session have a key configured?
scopus_has_key()
scopusflow documentation built on June 20, 2026, 5:06 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| scopus_has_key | R Documentation |
Locate the 'Scopus' API key and institutional token
Description
scopus_has_key() reports whether an API key can be found, without revealing
it. The key itself is resolved internally and is never printed by the
package.
Usage
scopus_has_key()
Details
The key is looked up first from the api_key argument of whichever function
is being called, then from the scopusflow.api_key option, and finally from
the SCOPUS_API_KEY environment variable. An optional institutional token,
used for off-campus access to subscriber content, is resolved the same way
from the inst_token argument, the scopusflow.inst_token option, or the
SCOPUS_INST_TOKEN environment variable.
A key is a secret. The safest home for it is ~/.Renviron, as in
SCOPUS_API_KEY=xxxx, rather than a script, and it should stay out of version
control.
Value
A length-one logical that is safe to print, TRUE when a non-empty
key is available and FALSE otherwise.
See Also
scopus_count(), scopus_fetch()
Examples
# Does the current session have a key configured?
scopus_has_key()
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.