A 如何为本手册作出贡献

如果你发现这个手册对你有帮助,欢迎你也贡献一份力量。如果你觉得这个手册没有什么用处,同样欢迎你提出建议,和我们一起来完善它。

A.1 直接Pull Request

如果你已经可以非常熟练地使用 Git 和 GitHub,那么你可以直接在 GitHub 上提交issues或Pull Request。

A.2 简易教程

如果你对 Git 和 GitHub 不太熟悉,也请不到担心,你仍然可以通过本教程,学习如何完成一个可以成为本手册一部分的Rmd文件。完成后你只需将新创建的Rmd文档发送给我们,审核通过后该文档内容就会出现在本实验室手册

A.2.1 下载示例

首先请下载示例。解压后你会看到一个名为labbook-mini的文件夹。

The minimal example directory

图 A.1: The minimal example directory

A.2.2 安装R和RStudio

如果你还没有安装R和RStudio,请先根据这里的信息安装相关软件以及进行相应的设置。

安装完成后,请不要忘了设置R包的镜像源

完成后请安装bookdown包,可以在RStudio中运行以下代码来实现:

install.packages("bookdown")

如果遇到问题,可以尝试查看这里的帮助信息

A.2.3 打开labbook.Rproj

直接双击labbook-mini文件夹中的labbook.Rproj文件,这样你就可以在RStudio中打开这个项目。

直接双击labbook-mini文件夹中的labbook.Rproj文件,这样你就可以在RStudio中打开这个项目。

Theorem A.1 直接双击labbook-mini文件夹中的labbook.Rproj文件,这样你就可以在RStudio中打开这个项目。

打开后你会看到如下的界面:
The minimal example R project

图 A.2: The minimal example R project

特别注意:请确保如上图 A.2右上角所示,当前的项目名称是labbook-mini。如果不是,请点击File -> Open project...,然后选择labbook-mini文件夹中的labbook.Rproj文件,重新打开该项目。

A.2.4 确认示例可以运行

现在我们可以尝试运行这个示例了。请在RStudio右上角找到Build,然后点击Build Book。如果一切顺利,会跳出一个窗口,同时你应该会在RStudio的右上角看到:
Build book for the minimal example

图 A.3: Build book for the minimal example

如果你不小心关掉了跳出的窗口,你应该会看到在labbook-mini文件夹中生成了一个_book子文件夹,里面包含了一个index.html文件。请双击这个文件通过浏览器打开,你会看到一个网页版的示例。

A.2.5 创建一个新的Rmd文件

现在我们可以开始创建一个新的Rmd文件来介绍你想贡献的内容了。比如你可以打开20-new.Rmd文件,然后将其另存为66-your_topic.Rmd。请确保你的文件名中包含了你的主题,这样我们可以更容易地了解不同Rmd文件的内容。

例如,你可以输入这些内容:

# 我的主题

    汇总:最棒的我     
    更新于:很开心的今天(或者2024年11月11日)

    就是想分享一下今天的快乐。。。

## 加一个二级标题


### 需要放一张照片

- 添加图片方式一:
```{r test-my-topic, echo=FALSE, fig.cap='我的图片', out.width='60%', fig.align='center'}
knitr::include_graphics(file.path("img", "jamovi", "anova.png"))
```

- 添加图片方式二:
![](img/jamovi/modules-library.png)

## 再给文字加一些颜料

随随便便放一些文字,看看效果如何。

我还想再给某一些文字加个链接,比如[这里](https://www.jamovi.org/)
或者再加一些特定的颜色,比如[红色]{color="red"}和[蓝色]{color="green"},
[对的,]{color="#5bc0eb"}[我就是]{color="#fa7921"}[想弄个]{color="#9bc53d"}
[Stroop效应]{color="#e55934"}(抱歉,颜色有点丑)。

### 再来一个列表

- 一个
- 两个
- 三个

1. 第一个
2. 第二个
3. 第三个

A.2.6 重新Build book

输入一些Rmarkdown内容后,请通过RStudio右上角的Build,再一次Build Book及时检查是否可以成功生成网页文件。如果你已经输入了上述所有代码,那你应该会看到

The new Rmd file output

图 A.4: The new Rmd file output

The new Rmd file output

图 A.5: The new Rmd file output

A.2.7 其他

如果你想再了解其他关于Rmarkdown/markdown的一些“特殊”用法,可以看看这里

就先这样吧。如果你有任何问题,欢迎随时联系我们

期待着你的Rmd会出现在手册里!