Scholar R 包使用教程

Scholar R 包使用教程

scholar Analyse citation data from Google Scholar 项目地址: https://gitcode.com/gh_mirrors/sch/scholar

1. 项目的目录结构及介绍

Scholar R 包的目录结构如下所示：

.
├── .Rbuildignore
├── .gitignore
├── DESCRIPTION
├── LICENSE
├── Makefile
├── NAMESPACE
├── NEWS
├── NEWS.md
├── README.md
├── cran-comments.md
├── inst
│   ├── DESCRIPTION
│   ├── examples
│   ├── exec
│   └── scripts
├── man
│   ├── CITATION
│   ├── examples
│   └── Rd
├── R
│   ├── citation.R
│   ├── get_citation_history.R
│   ├── get_profile.R
│   ├── get_publications.R
│   ├── scholar-package.R
│   └── utils.R
├── tests
│   ├── examples
│   ├── testthat
│   └── utils
└── vignettes
    └── scholar.Rmd

• .Rbuildignore：R 包构建时忽略的文件列表。
• .gitignore：Git 忽略的文件列表。
• DESCRIPTION：R 包描述文件，包含包的元数据。
• LICENSE：项目许可证文件。
• Makefile：构建 R 包的 Makefile 文件。
• NAMESPACE：R 包命名空间文件，定义了包的导入和导出对象。
• NEWS：项目更新日志文件。
• NEWS.md：项目更新日志的 Markdown 格式文件。
• README.md：项目自述文件，介绍了项目的基本信息和使用方法。
• cran-comments.md：CRAN 仓库的评论文件。
• inst：包含安装时需要复制的额外文件和目录。
• man：R 函数的帮助文档。
• R：R 包的核心代码文件。
• tests：单元测试文件。
• vignettes：项目宣传或教程性文档。

2. 项目的启动文件介绍

在 R 包中，没有所谓的“启动文件”。通常，R 包的使用是通过调用包中的函数来实现的。用户需要先安装包，然后加载包，才能使用其中的函数。

安装包的命令如下：

install.packages("scholar")

或者从 GitHub 安装最新版本：

if (!requireNamespace("remotes")) install.packages("remotes")
remotes::install_github("jkeirstead/scholar")

加载包的命令如下：

library(scholar)

加载后，用户可以调用如 get_profile()、get_citation_history() 和 get_publications() 等函数。

3. 项目的配置文件介绍

在 R 包中，配置文件通常指的是 DESCRIPTION 文件，它是 R 包的元数据文件，包含了包的基本信息，如下所示：

Package: scholar
Type: Package
Title: Analyse citation data from Google Scholar
Version: 0.1.6
Date: 2023-04-01
Author: Guangchuang Yu
Maintainer: Guangchuang Yu <guangchuangyu@gmail.com>
Description: Provides functions to extract citation data from Google Scholar.
License: MIT + file LICENSE
URL: https://github.com/jkeirstead/scholar
BugReports: https://github.com/jkeirstead/scholar/issues
Depends: R (>= 3.5.0)
Imports:httr, jsonlite
RoxygenNote: 7.1.1

此文件包含了包的名称、版本、作者、维护者、描述、许可证、URL、bug 报告地址等信息。在开发或使用 R 包时，需要确保此文件中的信息是最新的。

scholar Analyse citation data from Google Scholar 项目地址: https://gitcode.com/gh_mirrors/sch/scholar