Type:	Package
Title:	R Interface to Qiita API
Version:	0.1.1
Description:	Qiita is a technical knowledge sharing and collaboration platform for programmers. See https://qiita.com/api/v2/docs for more information.
URL:	https://github.com/yutannihilation/qiitr
BugReports:	https://github.com/yutannihilation/qiitr/issues
Depends:	R (≥ 2.10)
Imports:	httr, jsonlite, purrr, rstudioapi
LazyData:	TRUE
Encoding:	UTF-8
Suggests:	testthat
RoxygenNote:	7.1.0
License:	MIT + file LICENSE
NeedsCompilation:	no
Packaged:	2020-05-16 04:38:20 UTC; yutani
Author:	Hiroaki Yutani [aut, cre]
Maintainer:	Hiroaki Yutani <yutani.ini@gmail.com>
Repository:	CRAN
Date/Publication:	2020-05-16 05:40:02 UTC

qiitr: R Interface to Qiita API

Description

Qiita is a technical knowledge sharing and collaboration platform for programmers. See <https://qiita.com/api/v2/docs> for more information.

Author(s)

Maintainer: Hiroaki Yutani yutani.ini@gmail.com (ORCID)

See Also

Useful links:

• https://github.com/yutannihilation/qiitr

• Report bugs at https://github.com/yutannihilation/qiitr/issues

Send A Request To Qiita API

Description

An httr Wrapper for Qiita API.

Usage

qiita_api(
  verb,
  path,
  payload = NULL,
  query = NULL,
  per_page = 100L,
  page_offset = 0L,
  page_limit = 1L,
  .expect204 = FALSE
)

Arguments

Authorization with Qiita

Description

qiitr uses QIITA_ACCESSTOKEN environmental variable for authoriation. You can issue a personal access token at https://qiita.com/settings/applications. To set the envvar permanently, write QIITA_ACCESSTOKEN = (your access token) to a file and save it as .Renviron on current directory or the home directory (For more info, see Startup). To set the variable temporarily, use qiita_set_accesstoken.

Usage

qiita_set_accesstoken()

Qiita Comments API

Description

Get, write, update or delete comments via Qiita API.

Usage

qiita_get_comments(
  comment_id = NULL,
  item_id = NULL,
  per_page = 100L,
  page_offset = 0L,
  page_limit = 1L
)

qiita_delete_comment(comment_id)

qiita_update_comment(comment_id, body)

qiita_post_comment(item_id, body)

Arguments

Examples

## Not run: 
# get a comment by id
qiita_get_comments(comment_id = "1fdbb164e19d79e10203")

# get comments by item id
qiita_get_comments(item_id = "b4130186e1e095719dcb")

# post a comment to some item
qiita_post_comment(item_id = "123456789", body = "Thank you!!!")

## End(Not run)

Qiita Item (Article) API

Description

Get, post, delete, stock or unstock articles via Qiita API.

Usage

qiita_get_items(
  item_id = NULL,
  tag_id = NULL,
  user_id = NULL,
  query = NULL,
  per_page = 100L,
  page_offset = 0L,
  page_limit = 1L
)

qiita_post_item(
  title,
  body,
  tags = qiita_util_tag("R"),
  coediting = FALSE,
  private = TRUE,
  gist = FALSE,
  tweet = FALSE
)

qiita_delete_item(item_id)

qiita_update_item(
  item_id,
  title,
  body,
  tags = list(qiita_util_tag("R")),
  private = TRUE
)

qiita_stock_item(item_id)

qiita_unstock_item(item_id)

qiita_is_stocked_item(item_id)

qiita_get_stocks(user_id, per_page = 100L, page_offset = 0L, page_limit = 1L)

Arguments

Examples

## Not run: 
# get items by item ID
qiita_get_items(item_id = "7a78d897810446dd6a3b")

# get items by tag ID
qiita_get_items(tag_id = c("dplyr", "tidyr"), per_pages = 10L, page_limit = 1L)

# get items by user ID
qiita_get_items(user_id = "yutannihilation")

# Post an item. Note that the post is private by default.
# You should manually check if the post is valid before make it public.
item <- qiita_post_item(title = "test", body = "This is an example.")

# update the post
qiita_update_item(item$id, title = "test", body = "**This is a strong example!**")

# delete the post
qiita_delete_item(item$id)

## End(Not run)

Qiita Tag API

Description

Get, follow or unfollow tags via Qiita API.

Usage

qiita_get_tags(
  tag_id = NULL,
  user_id = NULL,
  per_page = 100L,
  page_offset = 0L,
  page_limit = 1L
)

qiita_follow_tag(tag_id)

qiita_unfollow_tag(tag_id)

qiita_is_following_tag(tag_id)

Arguments

Examples

## Not run: 
# get a tag by Tag IDs
qiita_get_tags(tag_id = "R")

# get tags by user ID
qiita_get_tags(user_id = "yutannihilation")

# follow a tag
qiita_follow_tag("RStudio")

# unfollow a tag
qiita_unfollow_tag("RStudio")

## End(Not run)

Qiita User API

Description

Get, follow or unfollow users via Qiita API.

Usage

qiita_get_stockers(item_id, per_page = 100L, page_offset = 0L, page_limit = 1L)

qiita_get_users(user_id)

qiita_get_followees(
  user_id,
  per_page = 100L,
  page_offset = 0L,
  page_limit = 1L
)

qiita_get_followers(
  user_id,
  per_page = 100L,
  page_offset = 0L,
  page_limit = 1L
)

qiita_follow_user(user_id)

qiita_unfollow_user(user_id)

qiita_is_following_user(user_id)

qiita_get_authenticated_user()

Arguments

Examples

## Not run: 
# get a user by id
qiita_get_users("yutannihilation")

# follow a user
qiita_follow_user("user1")

# unfollow a user
qiita_unfollow_user("user1")

# get the current user
qiita_get_authenticated_user()

## End(Not run)

Generate Payload And Tag For Qiita API

Description

Generate Payload And Tag For Qiita API

Usage

qiita_util_tag(name, versions = NULL)

qiita_util_payload(
  body = NULL,
  title = NULL,
  tags = NULL,
  private = NULL,
  coediting = NULL,
  gist = NULL,
  tweet = NULL
)

Arguments

Examples

qiita_util_tag(name = "R", versions = ">3.1")

qiita_util_payload(body = "foo",
                   title = "test",
                   tags = list(
                     qiita_util_tag(name = "R", versions = ">3.1"),
                     qiita_util_tag(name = "dplyr")
                   ),
                   private = TRUE)