Package 'jstager'

Title: Retrieve Information Published on J-STAGE
Description: Provides tools to access the J-STAGE WebAPI and retrieve information published on J-STAGE <https://www.jstage.jst.go.jp/browse/-char/ja>.
Authors: Takeshi Nishimura [aut, cph, cre]
Maintainer: Takeshi Nishimura <[email protected]>
License: MIT + file LICENSE
Version: 0.0.6
Built: 2025-03-08 04:16:18 UTC
Source: https://github.com/takeshinishimura/jstager

Help Index

Get J-Stage Articles List

Description

Retrieves a list of articles published on J-STAGE, including detailed information such as publication date and bibliographic metadata.

Usage

get_jstage_articles(
  pubyearfrom = NA,
  pubyearto = NA,
  material = "",
  article = "",
  author = "",
  affil = "",
  keyword = "",
  abst = "",
  text = "",
  issn = "",
  cdjournal = "",
  sortflg = NA,
  vol = NA,
  no = NA,
  start = NA,
  count = NA,
  sep = "\n",
  lang = "ja"
)

Arguments

pubyearfrom

An integer specifying the starting publication year (in YYYY format).
pubyearto

An integer specifying the ending publication year (in YYYY format).
material

A character string specifying the material name (partial match search, case insensitive).
article

A character string specifying the article title (partial match search, case insensitive).
author

A character string specifying the author name (partial match search, case insensitive).
affil

A character string specifying the affiliation (partial match search, case insensitive).
keyword

A character string specifying the keyword (partial match search, case insensitive).
abst

A character string specifying the abstract (partial match search, case insensitive).
text

A character string specifying the full text (partial match search, case insensitive).
issn

A character string specifying the ISSN (exact match search in XXXX-XXXX format).
cdjournal

A character string specifying the journal code.
sortflg

An integer specifying the sort flag: 1 for score order, 2 for volume, issue, and page order (default is 1).
vol

An integer specifying the volume (exact match).
no

An integer specifying the issue number (exact match).
start

An integer specifying the starting index for the search results.
count

An integer specifying the number of search results to retrieve (up to 1,000).
sep

A character string to separate multiple authors' names. Default is "\n".
lang

A character string specifying the language for column names: "ja" for Japanese (default is "ja").

Value

A list containing metadata and entry data frames with the search results.

Get J-Stage Volumes and Issues List

Description

Retrieves a list of volumes and issues published on J-STAGE.

Usage

get_jstage_volumes(
  pubyearfrom = NA,
  pubyearto = NA,
  material = "",
  issn = "",
  cdjournal = "",
  volorder = NA,
  lang = "ja"
)

Arguments

pubyearfrom

An integer specifying the starting publication year (in YYYY format).
pubyearto

An integer specifying the ending publication year (in YYYY format).
material

A character string specifying the material name (exact match search).
issn

A character string specifying the ISSN (exact match search in XXXX-XXXX format).
cdjournal

A character string specifying the journal code.
volorder

An integer specifying the order of volumes: 1 for ascending, 2 for descending (default is 1).
lang

A character string specifying the language for column names: "ja" for Japanese (default is "ja").

Value

A list containing metadata and entry data frames with the search results.

Scrape J-STAGE Article Metadata

Description

Scrapes all available metadata from a J-STAGE article web page.

Usage

jstage_metadata(url, collapse = NULL, pdf_path = NULL, bibtex_path = NULL)

Arguments

url

The URL or DOI of the J-STAGE article web page.
collapse

A character string to separate multiple authors' names and keywords. If you are unsure which string to use, please specify "\n".
pdf_path

The path where the PDF file of the article will be downloaded. If pdf_path is not NULL, the PDF file will be downloaded to the specified location. Specify "." to save the file in the working directory.
bibtex_path

The path to save the BibTeX entry. If bibtex_path is not NULL, a BibTeX file will be saved. Specify "." to save the file in the working directory.

Value

A list containing the article metadata.

Scrape J-STAGE References

Description

Scrapes all available references from a J-STAGE article web page.

Usage

jstage_references(url, depth = 1, citedby = FALSE, wait = 1, quiet = TRUE)

Arguments

url

The URL or DOI of the J-STAGE article web page.
depth

Integer. The depth to which references should be scraped. For example, a depth of 2 means the references of the specified paper and recursively the references of those references are scraped, and so on.
citedby

Logical. Set to TRUE to retrieve the list of cited-by references instead of the reference list. When set to TRUE, depth is automatically set to 1.
wait

Numeric. The number of seconds to wait between each request to reduce server load.
quiet

Logical. Set to FALSE to display information about the progress.

Value

A data frame with the DOI of each reference.

Write J-Stage Data to Excel File

Description

Writes the J-Stage search results to an Excel file.

Usage

write_jstage_to_excel(data, file_name)

Arguments

data

A list containing the metadata and entry data frames obtained from J-Stage.
file_name

A character string specifying the name of the Excel file to save the data.

Value

None. The function writes data to an Excel file.