Parse Dimensions CSV export files into an sm_corpus object.
Handles the standard Dimensions analytics platform CSV export format.
Usage
sm_read_dimensions(
path,
encoding = "UTF-8",
engine = c("native", "bibliometrix", "auto"),
verbose = TRUE,
call = rlang::caller_env()
)Arguments
- path
Character scalar. Path to a Dimensions CSV file.
- encoding
Character scalar. File encoding (default
"UTF-8").- engine
Character scalar. One of
"native"(built-in parser),"bibliometrix"(delegate tobibliometrix::convert2df()), or"auto"(try bibliometrix first, fall back to native).- verbose
Logical. Print progress messages?
- call
Caller environment for error reporting.
Value
An sm_corpus object.
Implementation
The native parser reads the Dimensions CSV export using readr::read_csv().
Dimensions CSV files may begin with informational rows before the header;
the parser skips lines that do not look like the header. Key columns
matched (case-insensitive): Title, DOI, Authors, Source title
(or Source Title), PubYear (or Publication Year), Times cited,
Document Type (or Publication Type), Abstract, Dimensions ID,
MeSH terms, Author Keywords, ISSN and Corresponding Authors.
The authors that the Corresponding Authors column names (;-separated,
an affiliation in parentheses after a name is ignored) get
authorships$is_corresponding = TRUE and the other authors of the
record FALSE; names are compared by surname and given names or
initials. A name that fits several authors equally, such as "Wang, Y"
for Wang Yan and Wang Yu, leaves them NA. Without that column, or when
it names none of the record's authors for certain, is_corresponding is
NA (unknown).
References
Aria, M. & Cuccurullo, C. (2017). bibliometrix: An R-tool for comprehensive science mapping analysis. Journal of Informetrics, 11(4), 959–975. doi:10.1016/j.joi.2017.08.007
Examples
corpus <- sm_read_dimensions(sm_example_files("example_dimensions.csv"), verbose = FALSE)
corpus
#>
#> ── <sm_corpus> ─────────────────────────────────────────────────────────────────
#> Works: 3 | Authors: 9 | Institutions: 0
#> Years: 2022 - 2024
#> Sources (journals): 3
#> Embeddings: none
#> Provenance: dimensions (3)
#> Status: Unlocked (last refreshed: never)
head(corpus$works)
#> # A tibble: 3 × 16
#> work_id doi title abstract year type source_id cited_by_count oa_status
#> <chr> <chr> <chr> <chr> <int> <chr> <chr> <int> <chr>
#> 1 W000000001 10.1… Spat… Spatial… 2023 Arti… S0000000… 42 NA
#> 2 W000000002 10.1… Mach… We deve… 2022 Arti… S0000000… 18 NA
#> 3 W000000003 10.1… Comp… This st… 2024 Revi… S0000000… 7 NA
#> # ℹ 7 more variables: language <chr>, pmid <chr>, arxiv_id <chr>,
#> # openalex_id <chr>, is_retracted <lgl>, retraction_date <date>,
#> # last_refreshed <dttm>