diff --git a/man/abstract_build.Rd b/man/abstract_build.Rd new file mode 100644 index 0000000..4f9eccb --- /dev/null +++ b/man/abstract_build.Rd @@ -0,0 +1,19 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/oa2df.R +\name{abstract_build} +\alias{abstract_build} +\title{Build abstract from inverted index} +\usage{ +abstract_build(ab, build = TRUE) +} +\arguments{ +\item{ab}{List. Inverted index of abstract.} + +\item{build}{Logical. If TRUE, build the abstract.} +} +\value{ +Character string. The abstract of the paper. +} +\description{ +Build abstract from inverted index +} diff --git a/man/authors2df.Rd b/man/authors2df.Rd index de43e5a..4aeb5d0 100644 --- a/man/authors2df.Rd +++ b/man/authors2df.Rd @@ -38,17 +38,11 @@ The function converts a list of authors' records obtained using \code{oa_request # University of Naples Federico II is associated to the OpenAlex id I71267560. -query_author <- oa_query( - identifier = NULL, +res <- oa_fetch( entity = "authors", last_known_institutions.id = "I71267560", - works_count = ">500" -) - -res <- oa_request( - query_url = query_author, - count_only = FALSE, - verbose = FALSE + works_count = ">700", + output = "list" ) df <- oa2df(res, entity = "authors") diff --git a/man/concepts2df.Rd b/man/concepts2df.Rd index 7d4999e..81c2a57 100644 --- a/man/concepts2df.Rd +++ b/man/concepts2df.Rd @@ -35,15 +35,10 @@ The function converts a list of concepts' records obtained using \code{oa_reques # Query to search information about all Italian educational institutions -query_inst <- oa_query( +res <- oa_query( entity = "concepts", - display_name.search = "electrodynamics" -) - -res <- oa_request( - query_url = query_inst, - count_only = FALSE, - verbose = FALSE + display_name.search = "electrodynamics", + output = "list" ) df <- oa2df(res, entity = "concepts") diff --git a/man/institutions2df.Rd b/man/institutions2df.Rd index dde3696..280c7c7 100644 --- a/man/institutions2df.Rd +++ b/man/institutions2df.Rd @@ -34,16 +34,11 @@ The function converts a list of institutions' records obtained using \code{oa_re # Query to search information about all Italian educational institutions -query_inst <- oa_query( +res <- oa_fetch( entity = "institutions", country_code = "it", - type = "education" -) - -res <- oa_request( - query_url = query_inst, - count_only = FALSE, - verbose = FALSE + type = "education", + output = "list" ) oa2df(res, entity = "institutions") diff --git a/man/oa2bibliometrix.Rd b/man/oa2bibliometrix.Rd index ae1ba93..f591c07 100644 --- a/man/oa2bibliometrix.Rd +++ b/man/oa2bibliometrix.Rd @@ -17,6 +17,9 @@ It converts bibliographic collections gathered from OpenAlex database \href{http bibliometrix data frame (\href{https://bibliometrix.org/}{https://bibliometrix.org/}) Column names follow https://images.webofknowledge.com/images/help/WOS/hs_wos_fieldtags.html. } +\details{ +Use \code{\link{bibliometrix::convert2df()}} (bibliometrix R package) instead. +} \examples{ \dontrun{ @@ -31,13 +34,10 @@ Column names follow https://images.webofknowledge.com/images/help/WOS/hs_wos_fie # Results have to be sorted by relevance score in a descending order. query <- oa_query( - identifier = NULL, entity = "works", cites = "W2755950973", - from_publication_date = "2021-01-01", - to_publication_date = "2021-12-31", - search = NULL, - endpoint = "https://api.openalex.org" + from_publication_date = "2021-10-01", + to_publication_date = "2021-12-31" ) res <- oa_request( diff --git a/man/process_affil.Rd b/man/process_affil.Rd new file mode 100644 index 0000000..d08cd30 --- /dev/null +++ b/man/process_affil.Rd @@ -0,0 +1,19 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/oa2df.R +\name{process_affil} +\alias{process_affil} +\title{Process affiliations} +\usage{ +process_affil(l_institution) +} +\arguments{ +\item{l_institution}{List. Nested elements include +id, display_name, ror, country_code, type, lineage} +} +\value{ +Dataframe of with the following columns: +id, display_name, ror, country_code, type, lineage +} +\description{ +Process affiliations +} diff --git a/man/process_paper_authors.Rd b/man/process_paper_authors.Rd new file mode 100644 index 0000000..77aa304 --- /dev/null +++ b/man/process_paper_authors.Rd @@ -0,0 +1,18 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/oa2df.R +\name{process_paper_authors} +\alias{process_paper_authors} +\title{Process paper authorships} +\usage{ +process_paper_authors(authorships) +} +\arguments{ +\item{authorships}{List. Authorships element of paper.} +} +\value{ +List. A list of one dataframe with the processed authors: +id, display_name, orcid, author_position, is_corresponding, affiliations, affiliation_raw +} +\description{ +Process paper authorships +} diff --git a/man/topics2df.Rd b/man/topics2df.Rd index 7694c03..7ad5580 100644 --- a/man/topics2df.Rd +++ b/man/topics2df.Rd @@ -35,15 +35,10 @@ The function converts a list of topics' records obtained using \code{oa_request} # Query to search information about all Italian educational institutions -query_inst <- oa_query( +res <- oa_query( entity = "topics", - display_name.search = "electrodynamics" -) - -res <- oa_request( - query_url = query_inst, - count_only = FALSE, - verbose = FALSE + display_name.search = "electrodynamics", + output = "list" ) df <- oa2df(res, entity = "topics")