Science Score: 10.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
○codemeta.json file
-
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 4 committers (25.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.6%) to scientific vocabulary
Keywords
Repository
An interface to the Request Tracker API
Basic Info
- Host: GitHub
- Owner: NCEAS
- License: other
- Language: R
- Default Branch: main
- Homepage: https://nceas.github.io/rt/
- Size: 428 KB
Statistics
- Stars: 6
- Watchers: 5
- Forks: 4
- Open Issues: 8
- Releases: 0
Topics
Metadata Files
README.md
rt
An interface to the RequestTracker API.
Installation
r
install.packages("rt")
Usage
Setup
To start using the rt package, log in to your RT instance by setting the server URL in using Sys.setenv and use rt_login() to log in and store your session locally.
Below, we log into Best Practical's demo installation of RT:
```r library(rt)
Sys.setenv("RTBASEURL" = "https://demo.bestpractical.com") rt_login() # Enter demo/demo ```
Once you are successfully logged in, you're all set to use the package.
The rt package supports all of the RequestTracker REST API:
- General
- Login:
rt_login() - Logout:
rt_logout()
- Login:
- Tickets
- Ticket Properties:
rt_ticket_properties() - Ticket Links:
rt_ticket_links() - Ticket Attachments:
rt_ticket_attachments() - Ticket Attachment:
rt_ticket_attachment() - Ticket Attachment Content:
rt_ticket_attachment_content() - Ticket History:
rt_ticket_history() - Ticket History Entry:
rt_ticket_history_entry() - Ticket Search:
rt_ticket_search() - Ticket Create:
rt_ticket_create() - Ticket Edit:
rt_ticket_edit() - Tickets History Reply:
rt_ticket_history_reply() - Ticket History Comment:
rt_ticket_history_comment() - Ticket Links Edit:
rt_ticket_links_edit()
- Ticket Properties:
- Users
- User Properties:
rt_user_properties() - User Create:
rt_user_create() - User Edit:
rt_user_edit()
- User Properties:
- Queues
- Queue Properties:
rt_queue_properties()
- Queue Properties:
Note: Most of these functions support being chained together (for example, with the %>%).
See the included vignettes for more information about usage.
Logging out
To log out, use the rt_logout function (or restart your R session):
r
rt_logout()
Development & Testing
A test suite is provided that is comprised mostly of integration tests that are configured to run against a local installation of RT.
By default, running devtools::test() will only run a small subset of the full test suite: those that do not depend on being able to call out to an RT installation (i.e., unit tests).
To run the full test suite locally,
Start a local RT installation with Docker:
sh docker run -d --name rt -p 80:80 netsandbox/request-trackerTurn on integration tests for your session
r Sys.setenv("RT_INTEGRATION" = TRUE)Run
devtools::test()from the same session as (2)
rt_api objects
All API calls go through an intermediate state as an rt_api object, which is made up of three parts:
- the
content, generally returned as a tibble/data frame - the
pathor URL that was accessed - the HTTP
responsefrom the API.
This is mainly to help normalize out some of the inconsistencies in the RT API itself and make implementing the API call wrappers easier.
Support / Issues / Feedback
Let us know about any issues or bugs.
Acknowledgements
Support was provided by the National Center for Ecological Analysis and Synthesis, a Center funded by the University of California, Santa Barbara, and the State of California.
Owner
- Name: National Center for Ecological Analysis and Synthesis
- Login: NCEAS
- Kind: organization
- Email: help@nceas.ucsb.edu
- Location: Santa Barbara, CA
- Website: https://www.nceas.ucsb.edu
- Repositories: 112
- Profile: https://github.com/NCEAS
GitHub Events
Total
Last Year
Committers
Last synced: over 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| Bryce Mecum | p****h@g****m | 191 |
| Irene | 2****s | 61 |
| Irene | j****e@e****m | 15 |
| Mitchell Maier | m****r@u****u | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 12 months ago
All Time
- Total issues: 29
- Total pull requests: 13
- Average time to close issues: 8 months
- Average time to close pull requests: 2 days
- Total issue authors: 3
- Total pull request authors: 3
- Average comments per issue: 2.1
- Average comments per pull request: 1.54
- Merged pull requests: 13
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- amoeba (19)
- isteves (9)
- dmullen17 (1)
Pull Request Authors
- isteves (11)
- maier-m (1)
- amoeba (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- cran 296 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 3
- Total maintainers: 1
cran.r-project.org: rt
Interface to the 'Request Tracker' API
- Homepage: https://github.com/nceas/rt
- Documentation: http://cran.r-project.org/web/packages/rt/rt.pdf
- License: MIT + file LICENSE
-
Latest release: 1.1.0
published about 5 years ago
Rankings
Maintainers (1)
Dependencies
- httr * imports
- stringr * imports
- askpass * suggests
- knitr * suggests
- rmarkdown * suggests
- testthat * suggests
- tibble * suggests