Getting profile(s) from the R (re)SPECIATE archive
rsp_profile(..., include.refs = FALSE)
rsp(...)
The function assumes all inputs (except include.refs
)
are SPECIES_CODE
s (the unique descriptor the EPA assigns to all
profiles in SPECIATE) or sources of profile information and requests these
form the local (re)SPECIATE archive. Typically, simple
objects like character and numeric vectors, as assumed to profile codes and
composite data-types like respeciate
objects or data.frame
,
are assumed to contain a named PROFILE_CODE
column. All potential
profile codes are requested and unrecognized codes are ignored.
logical, if profile reference information should be
included when extracting the requested profile(s) from the archive, default
FALSE
.
rsp_profile
or the short-hand rsp
return an object of
respeciate
class, a data.frame
containing one or more profile
from the local (re)SPECIATE archive.
The option include.refs
adds profile source reference
information to the returned respeciate
data set. The default option
is to not include these because some profiles have several associated
references and including these replicates records, once per reference.
respeciate
code is written to handle this but if you are developing
own methods or code and include references in any profile build you may be
biasing some analyses in favor of those multiple-reference profile unless
you check and account such cases.
Simon, H., Beck, L., Bhave, P.V., Divita, F., Hsu, Y., Luecken, D., Mobley, J.D., Pouliot, G.A., Reff, A., Sarwar, G. and Strum, M., 2010. The development and uses of EPA SPECIATE database. Atmospheric Pollution Research, 1(4), pp.196-206.
if (FALSE) {
x <- rsp_profile(8833, 8850)
plot(x)}