Skip to content

Commit

Permalink
docs: added description of issue_extract to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
angelchen7 committed Oct 31, 2024
1 parent 83e49c2 commit 57b25c7
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,7 @@ install.packages("scicomptools")
### Checking Access Tokens

- **`token_check`**: Checks for whether a token for the supplied API can be found for your current R session. For example, Qualtrics allows direct acquisition of data from R *if* you have a token and your R session "knows" that string. This function quickly checks whether you'd be able to use that workflow (currently only supports search for Qualtrics and GitHub tokens but could be easily expanded!)

### Exporting GitHub Issues as PDF Files

- **`issue_extract`**: Exports specified GitHub issues as PDF files when given the URL of a GitHub repository and a numeric vector of GitHub issue numbers. This function will export the first 10 issues as a default.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,10 @@ install.packages("scicomptools")
session “knows” that string. This function quickly checks whether
you’d be able to use that workflow (currently only supports search for
Qualtrics and GitHub tokens but could be easily expanded!)

### Exporting GitHub Issues as PDF Files

- **`issue_extract`**: Exports specified GitHub issues as PDF files when
given the URL of a GitHub repository and a numeric vector of GitHub
issue numbers. This function will export the first 10 issues as a
default.

0 comments on commit 57b25c7

Please sign in to comment.