| Type: | Package |
| Title: | A Client for the 'Pivotal Tracker' API |
| Description: | 'Pivotal Tracker' https://www.pivotaltracker.com is a project management software-as-a-service that provides a REST API. This package provides an R interface to that API, allowing you to query it and work with its responses. |
| Version: | 0.2.0 |
| URL: | https://enpiar.com/r/pivotaltrackR/, https://github.com/nealrichardson/pivotaltrackR/ |
| BugReports: | https://github.com/nealrichardson/pivotaltrackR/issues |
| License: | MIT + file LICENSE |
| Depends: | R (≥ 3.0.0) |
| Imports: | curl, httr, utils |
| Suggests: | httptest (≥ 3.0.0), knitr, magrittr, rmarkdown, spelling |
| Language: | en-US |
| Encoding: | UTF-8 |
| RoxygenNote: | 7.1.1 |
| VignetteBuilder: | knitr |
| NeedsCompilation: | no |
| Packaged: | 2021-01-10 21:18:34 UTC; enpiar |
| Author: | Neal Richardson [aut, cre] |
| Maintainer: | Neal Richardson <neal.p.richardson@gmail.com> |
| Repository: | CRAN |
| Date/Publication: | 2021-01-10 22:30:06 UTC |
Add labels to a story
Description
Add labels to a story
Usage
addLabel(story, labels = character(0))
addLabels(story, labels = character(0))
Arguments
story |
A |
labels |
Character vector of names of labels to add to the story |
Value
Invisibly, the story object with the labels added. If the story
already has all of the labels you're trying to add, no request will be made.
Get stories
Description
Get stories
Usage
getStories(..., search = NULL, query = list())
Arguments
... |
"Filter" terms to refine the query. See https://www.pivotaltracker.com/help/articles/advanced_search/. This is how you search for stories in the Pivotal Tracker web app. |
search |
A search string |
query |
List of query parameters. See https://www.pivotaltracker.com/help/api/rest/v5#Stories. Most are not valid when filter terms are used. |
Value
A 'stories' object: a list of all stories matching the search.
Examples
## Not run:
getStories(story_type="bug", current_state="unstarted",
search="deep learning")
## End(Not run)
Get a story's labels
Description
Get a story's labels
Usage
labels(story)
Arguments
story |
A |
Value
A character vector of the names of the labels attached to the story
Create, read, update, and delete a story
Description
Create, read, update, and delete a story
Usage
getStory(story)
createStory(...)
editStory(story, ...)
deleteStory(story)
Arguments
story |
An id string or URL to a Story |
... |
Story attributes to either |
Value
deleteStory returns nothing, while the other functions all return
a 'story' object: either the requested story (getStory), the newly
created story (createStory), or the current state of the modified story
editStory.
Examples
## Not run:
new_bug <- createStory(
name="Flux capacitor hangs at 0.9 gigawatts",
description="Please investigate and fix.",
story_type="bug"
)
new_bug <- editStory(new_bug, current_state="started")
deleteStory(new_bug)
## End(Not run)