https://github.com/yutannihilation/qiitaddin
An RStudio addin to post a knitted R Markdown file to Qiita
https://github.com/yutannihilation/qiitaddin
qiita r rstudio-addin
Last synced: 22 days ago
JSON representation
An RStudio addin to post a knitted R Markdown file to Qiita
- Host: GitHub
- URL: https://github.com/yutannihilation/qiitaddin
- Owner: yutannihilation
- License: other
- Created: 2015-12-23T13:46:04.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-04-01T15:27:00.000Z (about 8 years ago)
- Last Synced: 2025-04-02T01:03:21.734Z (26 days ago)
- Topics: qiita, r, rstudio-addin
- Language: R
- Size: 235 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
RStudio Addin to Post to Qiita
==============================
*Caution: This package is in the verrry early stages.*
### Installation
```r
library(devtools)
install_github("yutannihilation/qiitaddin")
```
### Preperation
#### Qiita access token
See: https://github.com/yutannihilation/qiitr#preperation
#### Imgur or Gyazo account
Since no method to upload image is provided by Qiita API, this package upload images to [Imgur](https://imgur.com/) or [Gyazo](https://gyazo.com/). Though Imgur allows us to upload images anonymously, I recommend you to create an acount on either service, since those images uploaded without the owner cannot be deleted afterwards (as this package won't record the `deletehash`).
You have been warned!
If you will upload many images, I recommend Gyazo, since Imgur has some secret limit rating which you will easily hit.
### Usage
After making sure that the target R Markdown file is active, click "Post to Qiita".
You can also type the command in your console.
```r
qiitaddin::qiitaddin_knit("path/to/file.Rmd")
```
After knitting the document is finished, the preview window appears. Review the document and edit the following items if necessary.
* `coediting`: A flag whether this item is co-edit mode (only available on Qiita:Team).
* `private`: A flag whether this item is private (only available on Qiita).
* `Upload images to`: Which service to upload images to. Currently, Imgur and Gyazo are supported.
* `update an existing item`: Whether to update an existing item or to create a new item.
* `Item ID`: The ID of an existing item.
When things are done, click "Done". (If you don't set `QIITA_ACCESSTOKEN` environmental variable, you will be asked to provide your Qiita access token)
After that, the document is posted to Qiita and you will jump to the page.
Note that there are one important thing you have to be careful about:
* Qiita is more formal place than Rpubs; Qiita people may get mad at you if you publish some test document that is not for sharing your knowledge, but for just testing Qiita API and this package. Never make it public.