diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 0000000..0184000 --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,41 @@ +# Run CI for R using https://eddelbuettel.github.io/r-ci/ + +name: ci + +on: + push: + pull_request: + +env: + _R_CHECK_FORCE_SUGGESTS_: "false" + +jobs: + ci: + strategy: + matrix: + include: + - {os: macos-latest} + - {os: ubuntu-latest} + + runs-on: ${{ matrix.os }} + + steps: + - uses: actions/checkout@v6 + + - name: Setup + uses: eddelbuettel/github-actions/r-ci@master + with: + dev_version: 'TRUE' + backend: 'RAPT' + + - name: Dependencies + run: ./run.sh install_deps + + - name: Test + run: ./run.sh run_tests + + #- name: Coverage + # if: ${{ matrix.os == 'ubuntu-latest' }} + # run: ./run.sh coverage + # env: + # CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} diff --git a/DESCRIPTION b/DESCRIPTION index 5c1628e..5893741 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,14 +1,8 @@ Package: tinyspotifyr Title: Tinyverse R Wrapper for the 'Spotify' Web API Version: 0.2.2 -Authors@R: c(person("Troy", "Hernandez", email = "troy.hernandez.phd@gmail.com", role = c("aut", "cre")), person("Charlie", "Thompson", email = "chuck@rcharlie.com", role = c("aut")), person("Josiah", "Parry", email = "josiah.parry@yahoo.com", role = "aut"), person("Donal", "Phipps", email = "donal.phipps@gmail.com", role = "aut"), person("Tom", "Wolff", email = "tom.wolff@duke.edu", role = "aut")) -Author: Troy Hernandez [aut, cre], - Charlie Thompson [aut], - Josiah Parry [aut], - Donal Phipps [aut], - Tom Wolff [aut] -Maintainer: Troy Hernandez -Description: An R wrapper for the 'Spotify' Web API +Authors@R: c(person("Troy", "Hernandez", email = "troy@cornball.ai", role = c("aut", "cre"), comment = c(ORCID = "0009-0005-4248-604X")), person("Charlie", "Thompson", email = "chuck@rcharlie.com", role = c("aut")), person("Josiah", "Parry", email = "josiah.parry@yahoo.com", role = "aut"), person("Donal", "Phipps", email = "donal.phipps@gmail.com", role = "aut"), person("Tom", "Wolff", email = "tom.wolff@duke.edu", role = "aut")) +Description: An R wrapper for the 'Spotify' Web API . Depends: R (>= 3.2) Imports: @@ -17,6 +11,5 @@ Imports: License: MIT + file LICENSE Encoding: UTF-8 LazyData: true -RoxygenNote: 7.1.1 -URL: https://github.com/TroyHernandez/tinyspotifyr -BugReports: https://github.com/TroyHernandez/tinyspotifyr/issues +URL: https://github.com/cornball-ai/tinyspotifyr +BugReports: https://github.com/cornball-ai/tinyspotifyr/issues diff --git a/NAMESPACE b/NAMESPACE index 1ee9434..a648972 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1,4 +1,4 @@ -# Generated by roxygen2: do not edit by hand +# tinyrox says don't edit this manually, but it can't stop you! export(add_items_to_playlist) export(add_latest_to_playlist) @@ -66,15 +66,16 @@ export(toggle_my_shuffle) export(transfer_my_playback) export(unfollow_playlist) export(verify_result) -importFrom(httr,GET) -importFrom(httr,RETRY) + importFrom(httr,accept_json) importFrom(httr,authenticate) importFrom(httr,config) importFrom(httr,content) -importFrom(httr,oauth2.0_token) +importFrom(httr,GET) importFrom(httr,oauth_app) importFrom(httr,oauth_endpoint) +importFrom(httr,oauth2.0_token) +importFrom(httr,RETRY) importFrom(httr,stop_for_status) importFrom(jsonlite,fromJSON) importFrom(jsonlite,toJSON) diff --git a/R/tinyspotifyr.R b/R/tinyspotifyr.R index 7e727b0..770ef16 100644 --- a/R/tinyspotifyr.R +++ b/R/tinyspotifyr.R @@ -1,15 +1,12 @@ -#' \code{tinyspotifyr} package -#' -#' A Quick and Easy Wrapper for Spotify's Web API +#' tinyspotifyr: A Quick and Easy Wrapper for Spotify's Web API #' #' See the README on #' \href{https://github.com/troyhernandez/tinyspotifyr#readme}{GitHub} #' -#' @docType package -#' @name tinyspotifyr #' @importFrom httr RETRY GET accept_json authenticate config content oauth2.0_token oauth_app oauth_endpoint stop_for_status #' @importFrom jsonlite fromJSON toJSON -NULL +#' @keywords internal +"_PACKAGE" globalVars <- c( "album_name", diff --git a/man/add_items_to_playlist.Rd b/man/add_items_to_playlist.Rd index 71e27c2..6dee384 100644 --- a/man/add_items_to_playlist.Rd +++ b/man/add_items_to_playlist.Rd @@ -1,16 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/playlists.R +% tinyrox says don't edit this manually, but it can't stop you! \name{add_items_to_playlist} \alias{add_items_to_playlist} \title{Add one or more tracks to a user’s playlist.} \usage{ -add_items_to_playlist( - playlist_id, - uris, - position = NULL, - market = "US", - authorization = get_spotify_authorization_code() -) +add_items_to_playlist(playlist_id, uris, position = NULL, market = "US", + authorization = get_spotify_authorization_code()) } \arguments{ \item{playlist_id}{Required. The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the playlist.} diff --git a/man/add_latest_to_playlist.Rd b/man/add_latest_to_playlist.Rd index f281a99..86c0988 100644 --- a/man/add_latest_to_playlist.Rd +++ b/man/add_latest_to_playlist.Rd @@ -1,16 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/playlists.R +% tinyrox says don't edit this manually, but it can't stop you! \name{add_latest_to_playlist} \alias{add_latest_to_playlist} \title{Add the latest episode of a podcast to a user’s playlist.} \usage{ -add_latest_to_playlist( - playlist_id, - uri, - position = NULL, - market = "US", - authorization = get_spotify_authorization_code() -) +add_latest_to_playlist(playlist_id, uri, position = NULL, market = "US", + authorization = get_spotify_authorization_code()) } \arguments{ \item{playlist_id}{Required. The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the playlist.} diff --git a/man/add_tracks_to_playlist.Rd b/man/add_tracks_to_playlist.Rd index c488b0f..ee4a91e 100644 --- a/man/add_tracks_to_playlist.Rd +++ b/man/add_tracks_to_playlist.Rd @@ -1,16 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/playlists.R +% tinyrox says don't edit this manually, but it can't stop you! \name{add_tracks_to_playlist} \alias{add_tracks_to_playlist} \title{Add one or more tracks to a user’s playlist.} \usage{ -add_tracks_to_playlist( - playlist_id, - uris, - position = NULL, - market = NULL, - authorization = get_spotify_authorization_code() -) +add_tracks_to_playlist(playlist_id, uris, position = NULL, market = NULL, + authorization = get_spotify_authorization_code()) } \arguments{ \item{playlist_id}{Required. The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the playlist.} diff --git a/man/change_playlist_details.Rd b/man/change_playlist_details.Rd index 443f6ec..8ab992e 100644 --- a/man/change_playlist_details.Rd +++ b/man/change_playlist_details.Rd @@ -1,17 +1,11 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/playlists.R +% tinyrox says don't edit this manually, but it can't stop you! \name{change_playlist_details} \alias{change_playlist_details} \title{Change a playlist’s name and public/private state. (The user must, of course, own the playlist.)} \usage{ -change_playlist_details( - playlist_id, - name = NULL, - public = NULL, - collaborative = NULL, - description = NULL, - authorization = get_spotify_authorization_code() -) +change_playlist_details(playlist_id, name = NULL, public = NULL, + collaborative = NULL, description = NULL, + authorization = get_spotify_authorization_code()) } \arguments{ \item{playlist_id}{Required. The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the playlist.} diff --git a/man/check_me_following.Rd b/man/check_me_following.Rd index c359ce8..77c9631 100644 --- a/man/check_me_following.Rd +++ b/man/check_me_following.Rd @@ -1,5 +1,4 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/follow.R +% tinyrox says don't edit this manually, but it can't stop you! \name{check_me_following} \alias{check_me_following} \title{Check if Current User Follows Artists or Users} diff --git a/man/check_users_following.Rd b/man/check_users_following.Rd index 2002adf..9fc5454 100644 --- a/man/check_users_following.Rd +++ b/man/check_users_following.Rd @@ -1,14 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/follow.R +% tinyrox says don't edit this manually, but it can't stop you! \name{check_users_following} \alias{check_users_following} \title{Check if Users Follow a Playlist} \usage{ -check_users_following( - playlist_id, - ids, - authorization = get_spotify_authorization_code() -) +check_users_following(playlist_id, ids, + authorization = get_spotify_authorization_code()) } \arguments{ \item{playlist_id}{Required. The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} of the playlist.} diff --git a/man/create_playlist.Rd b/man/create_playlist.Rd index 61313dd..205ddb9 100644 --- a/man/create_playlist.Rd +++ b/man/create_playlist.Rd @@ -1,17 +1,11 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/playlists.R +% tinyrox says don't edit this manually, but it can't stop you! \name{create_playlist} \alias{create_playlist} \title{Create a playlist for a Spotify user. (The playlist will be empty until you add tracks.)} \usage{ -create_playlist( - user_id, - name, - public = TRUE, - collaborative = FALSE, - description = NULL, - authorization = get_spotify_authorization_code() -) +create_playlist(user_id, name, public = TRUE, collaborative = FALSE, + description = NULL, + authorization = get_spotify_authorization_code()) } \arguments{ \item{user_id}{Required. The user's \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify user ID}.} diff --git a/man/follow_artists_or_users.Rd b/man/follow_artists_or_users.Rd index 8868ba7..1138281 100644 --- a/man/follow_artists_or_users.Rd +++ b/man/follow_artists_or_users.Rd @@ -1,14 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/follow.R +% tinyrox says don't edit this manually, but it can't stop you! \name{follow_artists_or_users} \alias{follow_artists_or_users} \title{Add the current user as a follower of one or more artists or other Spotify users.} \usage{ -follow_artists_or_users( - type, - ids, - authorization = get_spotify_authorization_code() -) +follow_artists_or_users(type, ids, + authorization = get_spotify_authorization_code()) } \arguments{ \item{type}{Required. The ID type: either \code{"artist"} or \code{"user"}.} diff --git a/man/follow_playlist.Rd b/man/follow_playlist.Rd index 7c4abf3..02884c0 100644 --- a/man/follow_playlist.Rd +++ b/man/follow_playlist.Rd @@ -1,14 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/follow.R +% tinyrox says don't edit this manually, but it can't stop you! \name{follow_playlist} \alias{follow_playlist} \title{Add the current user as a follower of a playlist.} \usage{ -follow_playlist( - playlist_id, - public = FALSE, - authorization = get_spotify_authorization_code() -) +follow_playlist(playlist_id, public = FALSE, + authorization = get_spotify_authorization_code()) } \arguments{ \item{playlist_id}{Required. The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} of the playlist. Any playlist can be followed, regardless of its \href{https://developer.spotify.com/documentation/general/guides/working-with-playlists/#public-private-and-collaborative-status}{public/private status}, as long as you know its playlist ID.} diff --git a/man/get_album.Rd b/man/get_album.Rd index 0927c15..5df67e8 100644 --- a/man/get_album.Rd +++ b/man/get_album.Rd @@ -1,5 +1,4 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/albums.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_album} \alias{get_album} \title{Get Spotify catalog information for a single album.} diff --git a/man/get_album_tracks.Rd b/man/get_album_tracks.Rd index eb19011..a1487b9 100644 --- a/man/get_album_tracks.Rd +++ b/man/get_album_tracks.Rd @@ -1,17 +1,11 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/albums.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_album_tracks} \alias{get_album_tracks} \title{Get Spotify catalog information about an album’s tracks. Optional parameters can be used to limit the number of tracks returned.} \usage{ -get_album_tracks( - id, - limit = 20, - offset = 0, - market = NULL, - authorization = get_spotify_access_token(), - include_meta_info = FALSE -) +get_album_tracks(id, limit = 20, offset = 0, market = NULL, + authorization = get_spotify_access_token(), + include_meta_info = FALSE) } \arguments{ \item{id}{Required. The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the album.} diff --git a/man/get_albums.Rd b/man/get_albums.Rd index 5039d3b..6c02393 100644 --- a/man/get_albums.Rd +++ b/man/get_albums.Rd @@ -1,15 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/albums.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_albums} \alias{get_albums} \title{Get Spotify catalog information for multiple albums identified by their Spotify IDs.} \usage{ -get_albums( - ids, - market = NULL, - authorization = get_spotify_access_token(), - include_meta_info = FALSE -) +get_albums(ids, market = NULL, authorization = get_spotify_access_token(), + include_meta_info = FALSE) } \arguments{ \item{ids}{Required. A character vector of the \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify IDs} for the albums. Maximum: 20 IDs.} diff --git a/man/get_artist.Rd b/man/get_artist.Rd index 7532a77..9632e22 100644 --- a/man/get_artist.Rd +++ b/man/get_artist.Rd @@ -1,5 +1,4 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/artists.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_artist} \alias{get_artist} \title{Get Spotify catalog information for a single artist identified by their unique Spotify ID.} diff --git a/man/get_artist_albums.Rd b/man/get_artist_albums.Rd index 5a8cf88..d4406f3 100644 --- a/man/get_artist_albums.Rd +++ b/man/get_artist_albums.Rd @@ -1,18 +1,13 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/artists.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_artist_albums} \alias{get_artist_albums} \title{Get Spotify catalog information for multiple artists identified by their Spotify IDs.} \usage{ -get_artist_albums( - id, - include_groups = c("album", "single", "appears_on", "compilation"), - market = NULL, - limit = 20, - offset = 0, - authorization = get_spotify_access_token(), - include_meta_info = FALSE -) +get_artist_albums(id, + include_groups = c("album", "single", "appears_on", "compilation"), + market = NULL, limit = 20, offset = 0, + authorization = get_spotify_access_token(), + include_meta_info = FALSE) } \arguments{ \item{id}{The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the artist.} diff --git a/man/get_artist_top_tracks.Rd b/man/get_artist_top_tracks.Rd index 8cb1ee6..fa5d212 100644 --- a/man/get_artist_top_tracks.Rd +++ b/man/get_artist_top_tracks.Rd @@ -1,15 +1,11 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/artists.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_artist_top_tracks} \alias{get_artist_top_tracks} \title{Get Spotify catalog information about an artist’s top tracks by country.} \usage{ -get_artist_top_tracks( - id, - market = "US", - authorization = get_spotify_access_token(), - include_meta_info = FALSE -) +get_artist_top_tracks(id, market = "US", + authorization = get_spotify_access_token(), + include_meta_info = FALSE) } \arguments{ \item{id}{The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the artist.} diff --git a/man/get_artists.Rd b/man/get_artists.Rd index 2729316..98f5be0 100644 --- a/man/get_artists.Rd +++ b/man/get_artists.Rd @@ -1,14 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/artists.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_artists} \alias{get_artists} \title{Get Spotify catalog information for multiple artists identified by their Spotify IDs.} \usage{ -get_artists( - ids, - authorization = get_spotify_access_token(), - include_meta_info = FALSE -) +get_artists(ids, authorization = get_spotify_access_token(), + include_meta_info = FALSE) } \arguments{ \item{ids}{Required. A character vector of the \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify IDs} for the artists. Maximum: 50 IDs.} diff --git a/man/get_categories.Rd b/man/get_categories.Rd index cd2f30a..eba3210 100644 --- a/man/get_categories.Rd +++ b/man/get_categories.Rd @@ -1,5 +1,4 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/browse.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_categories} \alias{get_categories} \title{Get a list of Spotify categories} diff --git a/man/get_category.Rd b/man/get_category.Rd index 482fbc3..423f9b2 100644 --- a/man/get_category.Rd +++ b/man/get_category.Rd @@ -1,15 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/browse.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_category} \alias{get_category} \title{Get a single category used to tag items in Spotify (on, for example, the Spotify player’s “Browse” tab).} \usage{ -get_category( - category_id, - country = NULL, - locale = NULL, - authorization = get_spotify_access_token() -) +get_category(category_id, country = NULL, locale = NULL, + authorization = get_spotify_access_token()) } \arguments{ \item{category_id}{Required. The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the category.} diff --git a/man/get_category_playlists.Rd b/man/get_category_playlists.Rd index 2e61c45..d18a2fb 100644 --- a/man/get_category_playlists.Rd +++ b/man/get_category_playlists.Rd @@ -1,17 +1,11 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/browse.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_category_playlists} \alias{get_category_playlists} \title{Get a list of Spotify playlists tagged with a particular category.} \usage{ -get_category_playlists( - category_id, - market = NULL, - limit = 20, - offset = 0, - authorization = get_spotify_access_token(), - include_meta_info = FALSE -) +get_category_playlists(category_id, market = NULL, limit = 20, offset = 0, + authorization = get_spotify_access_token(), + include_meta_info = FALSE) } \arguments{ \item{category_id}{Required. The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the category.} diff --git a/man/get_featured_playlists.Rd b/man/get_featured_playlists.Rd index 91d3d26..1ff9e5b 100644 --- a/man/get_featured_playlists.Rd +++ b/man/get_featured_playlists.Rd @@ -1,18 +1,12 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/browse.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_featured_playlists} \alias{get_featured_playlists} \title{Get a list of Spotify featured playlists (shown, for example, on a Spotify player’s ‘Browse’ tab).} \usage{ -get_featured_playlists( - locale = NULL, - country = NULL, - timestamp = NULL, - limit = 20, - offset = 0, - authorization = get_spotify_access_token(), - include_meta_info = FALSE -) +get_featured_playlists(locale = NULL, country = NULL, timestamp = NULL, + limit = 20, offset = 0, + authorization = get_spotify_access_token(), + include_meta_info = FALSE) } \arguments{ \item{locale}{Optional. The desired language, consisting of an \href{https://en.wikipedia.org/wiki/ISO_639-1}{ISO 639-1} language code and an \href{https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2}{ISO 3166-1 alpha-2 country code}, joined by an underscore. For example: \code{es_MX}, meaning "Spanish (Mexico)". Provide this parameter if you want the category strings returned in a particular language. Note that, if \code{locale} is not supplied, or if the specified language is not available, the category strings returned will be in the Spotify default language (American English). The \code{locale} parameter, combined with the \code{country} parameter, may give odd results if not carefully matched. For example \code{country=SE&locale=de_DE} will return a list of categories relevant to Sweden but as German language strings.} diff --git a/man/get_latest_episode.Rd b/man/get_latest_episode.Rd index 9eb4b0b..a7d09c2 100644 --- a/man/get_latest_episode.Rd +++ b/man/get_latest_episode.Rd @@ -1,14 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/shows.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_latest_episode} \alias{get_latest_episode} \title{Get Spotify uri information for a show's latest episodes identified by their unique Spotify ID.} \usage{ -get_latest_episode( - id, - market = "US", - authorization = get_spotify_authorization_code() -) +get_latest_episode(id, market = "US", + authorization = get_spotify_authorization_code()) } \arguments{ \item{id}{The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the show.} diff --git a/man/get_my_current_playback.Rd b/man/get_my_current_playback.Rd index bbc515e..364d56c 100644 --- a/man/get_my_current_playback.Rd +++ b/man/get_my_current_playback.Rd @@ -1,13 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/player.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_my_current_playback} \alias{get_my_current_playback} \title{Get information about the user’s current playback state, including track, track progress, and active device.} \usage{ -get_my_current_playback( - market = NULL, - authorization = get_spotify_authorization_code() -) +get_my_current_playback(market = NULL, + authorization = get_spotify_authorization_code()) } \arguments{ \item{market}{An ISO 3166-1 alpha-2 country code or the string \code{"from_token"}. Provide this parameter if you want to apply \href{https://developer.spotify.com/documentation/general/guides/track-relinking-guide/}{Track Relinking}} diff --git a/man/get_my_currently_playing.Rd b/man/get_my_currently_playing.Rd index e3dd30a..6fc861b 100644 --- a/man/get_my_currently_playing.Rd +++ b/man/get_my_currently_playing.Rd @@ -1,13 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/player.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_my_currently_playing} \alias{get_my_currently_playing} \title{Get the object currently being played on the user’s Spotify account.} \usage{ -get_my_currently_playing( - market = NULL, - authorization = get_spotify_authorization_code() -) +get_my_currently_playing(market = NULL, + authorization = get_spotify_authorization_code()) } \arguments{ \item{market}{An ISO 3166-1 alpha-2 country code or the string \code{"from_token"}. Provide this parameter if you want to apply \href{https://developer.spotify.com/documentation/general/guides/track-relinking-guide/}{Track Relinking}} diff --git a/man/get_my_devices.Rd b/man/get_my_devices.Rd index 73eba6b..51cd261 100644 --- a/man/get_my_devices.Rd +++ b/man/get_my_devices.Rd @@ -1,5 +1,4 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/player.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_my_devices} \alias{get_my_devices} \title{Get information about a user’s available devices.} diff --git a/man/get_my_followed_artists.Rd b/man/get_my_followed_artists.Rd index 8f9287b..34fe9e2 100644 --- a/man/get_my_followed_artists.Rd +++ b/man/get_my_followed_artists.Rd @@ -1,15 +1,11 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/follow.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_my_followed_artists} \alias{get_my_followed_artists} \title{Get the current user’s followed artists.} \usage{ -get_my_followed_artists( - limit = 20, - after = NULL, - authorization = get_spotify_authorization_code(), - include_meta_info = FALSE -) +get_my_followed_artists(limit = 20, after = NULL, + authorization = get_spotify_authorization_code(), + include_meta_info = FALSE) } \arguments{ \item{limit}{Optional. The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.} diff --git a/man/get_my_playlists.Rd b/man/get_my_playlists.Rd index b75b143..61f6015 100644 --- a/man/get_my_playlists.Rd +++ b/man/get_my_playlists.Rd @@ -1,15 +1,11 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/playlists.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_my_playlists} \alias{get_my_playlists} \title{Get a list of the playlists owned or followed by the current Spotify user.} \usage{ -get_my_playlists( - limit = 20, - offset = 0, - authorization = get_spotify_authorization_code(), - include_meta_info = FALSE -) +get_my_playlists(limit = 20, offset = 0, + authorization = get_spotify_authorization_code(), + include_meta_info = FALSE) } \arguments{ \item{limit}{Optional. \cr diff --git a/man/get_my_profile.Rd b/man/get_my_profile.Rd index 4dc073e..6695fea 100644 --- a/man/get_my_profile.Rd +++ b/man/get_my_profile.Rd @@ -1,5 +1,4 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/users_profile.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_my_profile} \alias{get_my_profile} \title{Get detailed profile information about the current user (including the current user’s username).} diff --git a/man/get_my_recently_played.Rd b/man/get_my_recently_played.Rd index 313a468..2445039 100644 --- a/man/get_my_recently_played.Rd +++ b/man/get_my_recently_played.Rd @@ -1,16 +1,11 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/player.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_my_recently_played} \alias{get_my_recently_played} \title{Get Current User's Recently Played Tracks} \usage{ -get_my_recently_played( - limit = 20, - after = NULL, - before = NULL, - authorization = get_spotify_authorization_code(), - include_meta_info = FALSE -) +get_my_recently_played(limit = 20, after = NULL, before = NULL, + authorization = get_spotify_authorization_code(), + include_meta_info = FALSE) } \arguments{ \item{limit}{Optional. The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.} diff --git a/man/get_my_saved_albums.Rd b/man/get_my_saved_albums.Rd index 6255730..6b89b78 100644 --- a/man/get_my_saved_albums.Rd +++ b/man/get_my_saved_albums.Rd @@ -1,16 +1,11 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/library.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_my_saved_albums} \alias{get_my_saved_albums} \title{Get Current User's Saved Albums} \usage{ -get_my_saved_albums( - limit = 20, - offset = 0, - market = NULL, - authorization = get_spotify_authorization_code(), - include_meta_info = FALSE -) +get_my_saved_albums(limit = 20, offset = 0, market = NULL, + authorization = get_spotify_authorization_code(), + include_meta_info = FALSE) } \arguments{ \item{limit}{Optional. \cr diff --git a/man/get_my_saved_tracks.Rd b/man/get_my_saved_tracks.Rd index bb54231..4e48b5f 100644 --- a/man/get_my_saved_tracks.Rd +++ b/man/get_my_saved_tracks.Rd @@ -1,16 +1,11 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/library.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_my_saved_tracks} \alias{get_my_saved_tracks} \title{Get a User's Saved Tracks} \usage{ -get_my_saved_tracks( - limit = 20, - offset = 0, - market = NULL, - authorization = get_spotify_authorization_code(), - include_meta_info = FALSE -) +get_my_saved_tracks(limit = 20, offset = 0, market = NULL, + authorization = get_spotify_authorization_code(), + include_meta_info = FALSE) } \arguments{ \item{limit}{Optional. \cr diff --git a/man/get_my_top_artists_or_tracks.Rd b/man/get_my_top_artists_or_tracks.Rd index eb9f4f0..dbe291f 100644 --- a/man/get_my_top_artists_or_tracks.Rd +++ b/man/get_my_top_artists_or_tracks.Rd @@ -1,17 +1,12 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/personalization.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_my_top_artists_or_tracks} \alias{get_my_top_artists_or_tracks} \title{Get the current user’s top artists or tracks based on calculated affinity.} \usage{ -get_my_top_artists_or_tracks( - type = NULL, - limit = 20, - offset = 0, - time_range = "medium_term", - authorization = get_spotify_authorization_code(), - include_meta_info = FALSE -) +get_my_top_artists_or_tracks(type = NULL, limit = 20, offset = 0, + time_range = "medium_term", + authorization = get_spotify_authorization_code(), + include_meta_info = FALSE) } \arguments{ \item{type}{Required. The type of entity to return. Valid values: \code{artists} or \code{tracks}.} diff --git a/man/get_new_releases.Rd b/man/get_new_releases.Rd index 624e3bf..3dc0e0d 100644 --- a/man/get_new_releases.Rd +++ b/man/get_new_releases.Rd @@ -1,16 +1,11 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/browse.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_new_releases} \alias{get_new_releases} \title{Get a list of new album releases featured in Spotify (shown, for example, on a Spotify player’s “Browse” tab).} \usage{ -get_new_releases( - country = NULL, - limit = 20, - offset = 0, - authorization = get_spotify_access_token(), - include_meta_info = FALSE -) +get_new_releases(country = NULL, limit = 20, offset = 0, + authorization = get_spotify_access_token(), + include_meta_info = FALSE) } \arguments{ \item{country}{Optional. A country: an \href{https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2}{ISO 3166-1 alpha-2 country code}. Provide this parameter if you want the list of returned items to be relevant to a particular country. If omitted, the returned items will be relevant to all countries.} diff --git a/man/get_playlist.Rd b/man/get_playlist.Rd index c36667c..1eb0417 100644 --- a/man/get_playlist.Rd +++ b/man/get_playlist.Rd @@ -1,15 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/playlists.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_playlist} \alias{get_playlist} \title{Get a playlist owned by a Spotify user.} \usage{ -get_playlist( - playlist_id, - fields = NULL, - market = NULL, - authorization = get_spotify_access_token() -) +get_playlist(playlist_id, fields = NULL, market = NULL, + authorization = get_spotify_access_token()) } \arguments{ \item{playlist_id}{Required. The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the playlist.} diff --git a/man/get_playlist_cover_image.Rd b/man/get_playlist_cover_image.Rd index d445425..50abdc9 100644 --- a/man/get_playlist_cover_image.Rd +++ b/man/get_playlist_cover_image.Rd @@ -1,13 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/playlists.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_playlist_cover_image} \alias{get_playlist_cover_image} \title{Get the current image associated with a specific playlist.} \usage{ -get_playlist_cover_image( - playlist_id, - authorization = get_spotify_authorization_code() -) +get_playlist_cover_image(playlist_id, + authorization = get_spotify_authorization_code()) } \arguments{ \item{playlist_id}{Required. The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the playlist.} diff --git a/man/get_playlist_items.Rd b/man/get_playlist_items.Rd index 7aa7273..2058927 100644 --- a/man/get_playlist_items.Rd +++ b/man/get_playlist_items.Rd @@ -1,18 +1,11 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/playlists.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_playlist_items} \alias{get_playlist_items} \title{Get full details of the items of a playlist owned by a Spotify user.} \usage{ -get_playlist_items( - playlist_id, - fields = NULL, - limit = 100, - offset = 0, - market = NULL, - authorization = get_spotify_access_token(), - include_meta_info = FALSE -) +get_playlist_items(playlist_id, fields = NULL, limit = 100, offset = 0, + market = NULL, authorization = get_spotify_access_token(), + include_meta_info = FALSE) } \arguments{ \item{playlist_id}{Required. The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the playlist.} diff --git a/man/get_playlist_tracks.Rd b/man/get_playlist_tracks.Rd index 31b868a..6ad6175 100644 --- a/man/get_playlist_tracks.Rd +++ b/man/get_playlist_tracks.Rd @@ -1,18 +1,11 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/playlists.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_playlist_tracks} \alias{get_playlist_tracks} \title{Get full details of the tracks of a playlist owned by a Spotify user.} \usage{ -get_playlist_tracks( - playlist_id, - fields = NULL, - limit = 100, - offset = 0, - market = NULL, - authorization = get_spotify_access_token(), - include_meta_info = FALSE -) +get_playlist_tracks(playlist_id, fields = NULL, limit = 100, offset = 0, + market = NULL, authorization = get_spotify_access_token(), + include_meta_info = FALSE) } \arguments{ \item{playlist_id}{Required. The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the playlist.} diff --git a/man/get_recommendations.Rd b/man/get_recommendations.Rd index 95b9dea..43dec63 100644 --- a/man/get_recommendations.Rd +++ b/man/get_recommendations.Rd @@ -1,60 +1,32 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/browse.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_recommendations} \alias{get_recommendations} \title{Create a playlist-style listening experience based on seed artists, tracks and genres.} \usage{ -get_recommendations( - limit = 20, - market = NULL, - seed_artists = NULL, - seed_genres = NULL, - seed_tracks = NULL, - max_acousticness = NULL, - max_danceability = NULL, - max_duration_ms = NULL, - max_energy = NULL, - max_instrumentalness = NULL, - max_key = NULL, - max_liveness = NULL, - max_loudness = NULL, - max_mode = NULL, - max_popularity = NULL, - max_speechiness = NULL, - max_tempo = NULL, - max_time_signature = NULL, - max_valence = NULL, - min_acousticness = NULL, - min_danceability = NULL, - min_duration_ms = NULL, - min_energy = NULL, - min_instrumentalness = NULL, - min_key = NULL, - min_liveness = NULL, - min_loudness = NULL, - min_mode = NULL, - min_popularity = NULL, - min_speechiness = NULL, - min_tempo = NULL, - min_time_signature = NULL, - min_valence = NULL, - target_acousticness = NULL, - target_danceability = NULL, - target_duration_ms = NULL, - target_energy = NULL, - target_instrumentalness = NULL, - target_key = NULL, - target_liveness = NULL, - target_loudness = NULL, - target_mode = NULL, - target_popularity = NULL, - target_speechiness = NULL, - target_tempo = NULL, - target_time_signature = NULL, - target_valence = NULL, - authorization = get_spotify_access_token(), - include_seeds_in_response = FALSE -) +get_recommendations(limit = 20, market = NULL, seed_artists = NULL, + seed_genres = NULL, seed_tracks = NULL, + max_acousticness = NULL, max_danceability = NULL, + max_duration_ms = NULL, max_energy = NULL, + max_instrumentalness = NULL, max_key = NULL, + max_liveness = NULL, max_loudness = NULL, max_mode = NULL, + max_popularity = NULL, max_speechiness = NULL, + max_tempo = NULL, max_time_signature = NULL, + max_valence = NULL, min_acousticness = NULL, + min_danceability = NULL, min_duration_ms = NULL, + min_energy = NULL, min_instrumentalness = NULL, + min_key = NULL, min_liveness = NULL, min_loudness = NULL, + min_mode = NULL, min_popularity = NULL, + min_speechiness = NULL, min_tempo = NULL, + min_time_signature = NULL, min_valence = NULL, + target_acousticness = NULL, target_danceability = NULL, + target_duration_ms = NULL, target_energy = NULL, + target_instrumentalness = NULL, target_key = NULL, + target_liveness = NULL, target_loudness = NULL, + target_mode = NULL, target_popularity = NULL, + target_speechiness = NULL, target_tempo = NULL, + target_time_signature = NULL, target_valence = NULL, + authorization = get_spotify_access_token(), + include_seeds_in_response = FALSE) } \arguments{ \item{limit}{Optional. The target size of the list of recommended tracks. For seeds with unusually small pools or when highly restrictive filtering is applied, it may be impossible to generate the requested number of recommended tracks. Debugging information for such cases is available in the response. Default: 20. Minimum: 1. Maximum: 100.} diff --git a/man/get_related_artists.Rd b/man/get_related_artists.Rd index fcd1df7..d0ea550 100644 --- a/man/get_related_artists.Rd +++ b/man/get_related_artists.Rd @@ -1,14 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/artists.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_related_artists} \alias{get_related_artists} \title{Get Spotify catalog information about artists similar to a given artist. Similarity is based on analysis of the Spotify community’s listening history.} \usage{ -get_related_artists( - id, - authorization = get_spotify_access_token(), - include_meta_info = FALSE -) +get_related_artists(id, authorization = get_spotify_access_token(), + include_meta_info = FALSE) } \arguments{ \item{id}{The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the artist.} diff --git a/man/get_show.Rd b/man/get_show.Rd index bd54996..239a050 100644 --- a/man/get_show.Rd +++ b/man/get_show.Rd @@ -1,5 +1,4 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/shows.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_show} \alias{get_show} \title{Get Spotify catalog information for a single show identified by their unique Spotify ID.} diff --git a/man/get_shows.Rd b/man/get_shows.Rd index 6924518..4456490 100644 --- a/man/get_shows.Rd +++ b/man/get_shows.Rd @@ -1,5 +1,4 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/shows.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_shows} \alias{get_shows} \title{Get Spotify catalog information for a single show identified by their unique Spotify ID.} diff --git a/man/get_shows_episodes.Rd b/man/get_shows_episodes.Rd index f4b5211..471844e 100644 --- a/man/get_shows_episodes.Rd +++ b/man/get_shows_episodes.Rd @@ -1,14 +1,9 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/shows.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_shows_episodes} \alias{get_shows_episodes} \title{Get Spotify catalog information for a show's episodes identified by their unique Spotify ID.} \usage{ -get_shows_episodes( - id, - market = "US", - authorization = get_spotify_access_token() -) +get_shows_episodes(id, market = "US", authorization = get_spotify_access_token()) } \arguments{ \item{id}{The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the show.} diff --git a/man/get_spotify_access_token.Rd b/man/get_spotify_access_token.Rd index 8ba9add..5010208 100644 --- a/man/get_spotify_access_token.Rd +++ b/man/get_spotify_access_token.Rd @@ -1,13 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/authenticate.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_spotify_access_token} \alias{get_spotify_access_token} \title{Get Spotify Access Token} \usage{ -get_spotify_access_token( - client_id = Sys.getenv("SPOTIFY_CLIENT_ID"), - client_secret = Sys.getenv("SPOTIFY_CLIENT_SECRET") -) +get_spotify_access_token(client_id = Sys.getenv("SPOTIFY_CLIENT_ID"), + client_secret = Sys.getenv("SPOTIFY_CLIENT_SECRET")) } \arguments{ \item{client_id}{Defaults to System Environment variable "SPOTIFY_CLIENT_ID"} diff --git a/man/get_spotify_authorization_code.Rd b/man/get_spotify_authorization_code.Rd index f086a67..0733b81 100644 --- a/man/get_spotify_authorization_code.Rd +++ b/man/get_spotify_authorization_code.Rd @@ -1,14 +1,11 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/authenticate.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_spotify_authorization_code} \alias{get_spotify_authorization_code} \title{Get Spotify authorization Code} \usage{ -get_spotify_authorization_code( - client_id = Sys.getenv("SPOTIFY_CLIENT_ID"), - client_secret = Sys.getenv("SPOTIFY_CLIENT_SECRET"), - scope = tinyspotifyr::scopes -) +get_spotify_authorization_code(client_id = Sys.getenv("SPOTIFY_CLIENT_ID"), + client_secret = Sys.getenv("SPOTIFY_CLIENT_SECRET"), + scope = tinyspotifyr::scopes) } \arguments{ \item{client_id}{Defaults to System Envioronment variable "SPOTIFY_CLIENT_ID"} diff --git a/man/get_track.Rd b/man/get_track.Rd index eb25811..59c2eaf 100644 --- a/man/get_track.Rd +++ b/man/get_track.Rd @@ -1,5 +1,4 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/tracks.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_track} \alias{get_track} \title{Get Spotify catalog information for a single track identified by its unique Spotify ID.} diff --git a/man/get_track_audio_analysis.Rd b/man/get_track_audio_analysis.Rd index 84de2ff..e3b22f3 100644 --- a/man/get_track_audio_analysis.Rd +++ b/man/get_track_audio_analysis.Rd @@ -1,5 +1,4 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/tracks.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_track_audio_analysis} \alias{get_track_audio_analysis} \title{Get a detailed audio analysis for a single track identified by its unique Spotify ID.} diff --git a/man/get_track_audio_features.Rd b/man/get_track_audio_features.Rd index 4942286..932feeb 100644 --- a/man/get_track_audio_features.Rd +++ b/man/get_track_audio_features.Rd @@ -1,5 +1,4 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/tracks.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_track_audio_features} \alias{get_track_audio_features} \title{Get audio feature information for a single track identified by its unique Spotify ID.} diff --git a/man/get_tracks.Rd b/man/get_tracks.Rd index bc4abd5..cd0aa39 100644 --- a/man/get_tracks.Rd +++ b/man/get_tracks.Rd @@ -1,15 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/tracks.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_tracks} \alias{get_tracks} \title{Get Spotify catalog information for a single track identified by its unique Spotify ID.} \usage{ -get_tracks( - ids, - market = NULL, - authorization = get_spotify_access_token(), - include_meta_info = FALSE -) +get_tracks(ids, market = NULL, authorization = get_spotify_access_token(), + include_meta_info = FALSE) } \arguments{ \item{ids}{The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the track.} diff --git a/man/get_user_playlists.Rd b/man/get_user_playlists.Rd index ff1ae59..13a1608 100644 --- a/man/get_user_playlists.Rd +++ b/man/get_user_playlists.Rd @@ -1,16 +1,11 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/playlists.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_user_playlists} \alias{get_user_playlists} \title{Get a list of the playlists owned or followed by a Spotify user.} \usage{ -get_user_playlists( - user_id, - limit = 20, - offset = 0, - authorization = get_spotify_authorization_code(), - include_meta_info = FALSE -) +get_user_playlists(user_id, limit = 20, offset = 0, + authorization = get_spotify_authorization_code(), + include_meta_info = FALSE) } \arguments{ \item{user_id}{Required. The user's \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify user ID}.} diff --git a/man/get_user_profile.Rd b/man/get_user_profile.Rd index 5e7da79..2c88610 100644 --- a/man/get_user_profile.Rd +++ b/man/get_user_profile.Rd @@ -1,5 +1,4 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/users_profile.R +% tinyrox says don't edit this manually, but it can't stop you! \name{get_user_profile} \alias{get_user_profile} \title{Get public profile information about a Spotify user.} diff --git a/man/is_uri.Rd b/man/is_uri.Rd index 43086ab..fb2f641 100644 --- a/man/is_uri.Rd +++ b/man/is_uri.Rd @@ -1,5 +1,4 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/utils.R +% tinyrox says don't edit this manually, but it can't stop you! \name{is_uri} \alias{is_uri} \title{Check if a string matches the pattern of a Spotify URI} diff --git a/man/pause_my_playback.Rd b/man/pause_my_playback.Rd index 589c169..0ae3831 100644 --- a/man/pause_my_playback.Rd +++ b/man/pause_my_playback.Rd @@ -1,13 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/player.R +% tinyrox says don't edit this manually, but it can't stop you! \name{pause_my_playback} \alias{pause_my_playback} \title{Pause playback on the user’s account.} \usage{ -pause_my_playback( - device_id = NULL, - authorization = get_spotify_authorization_code() -) +pause_my_playback(device_id = NULL, + authorization = get_spotify_authorization_code()) } \arguments{ \item{device_id}{Optional. The id of the device this command is targeting. If not supplied, the user’s currently active device is the target.} diff --git a/man/pitch_class_lookup.Rd b/man/pitch_class_lookup.Rd index 97188c5..2ec4043 100644 --- a/man/pitch_class_lookup.Rd +++ b/man/pitch_class_lookup.Rd @@ -1,5 +1,4 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/utils.R +% tinyrox says don't edit this manually, but it can't stop you! \docType{data} \name{pitch_class_lookup} \alias{pitch_class_lookup} @@ -10,9 +9,6 @@ An object of class \code{character} of length 12. \usage{ pitch_class_lookup } -\value{ -Returns a character vector. -} \description{ Pitch class notation lookup } diff --git a/man/remove_tracks_from_playlist.Rd b/man/remove_tracks_from_playlist.Rd index e1e57c2..ca22aff 100644 --- a/man/remove_tracks_from_playlist.Rd +++ b/man/remove_tracks_from_playlist.Rd @@ -1,14 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/playlists.R +% tinyrox says don't edit this manually, but it can't stop you! \name{remove_tracks_from_playlist} \alias{remove_tracks_from_playlist} \title{Remove one or more tracks from a user’s playlist.} \usage{ -remove_tracks_from_playlist( - playlist_id, - uris, - authorization = get_spotify_authorization_code() -) +remove_tracks_from_playlist(playlist_id, uris, + authorization = get_spotify_authorization_code()) } \arguments{ \item{playlist_id}{Required. The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the playlist.} diff --git a/man/reorder_replace_playlist_items.Rd b/man/reorder_replace_playlist_items.Rd index 2c7c802..7e7f782 100644 --- a/man/reorder_replace_playlist_items.Rd +++ b/man/reorder_replace_playlist_items.Rd @@ -1,14 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/playlists.R +% tinyrox says don't edit this manually, but it can't stop you! \name{reorder_replace_playlist_items} \alias{reorder_replace_playlist_items} \title{Reorder or replace one or more items from a user’s playlist.} \usage{ -reorder_replace_playlist_items( - playlist_id, - uris, - authorization = get_spotify_authorization_code() -) +reorder_replace_playlist_items(playlist_id, uris, + authorization = get_spotify_authorization_code()) } \arguments{ \item{playlist_id}{Required. The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} for the playlist.} diff --git a/man/scopes.Rd b/man/scopes.Rd index 013787c..7569541 100644 --- a/man/scopes.Rd +++ b/man/scopes.Rd @@ -1,5 +1,4 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/utils.R +% tinyrox says don't edit this manually, but it can't stop you! \docType{data} \name{scopes} \alias{scopes} @@ -10,9 +9,6 @@ An object of class \code{character} of length 19. \usage{ scopes } -\value{ -Returns a character vector. -} \description{ Vector of valid scopes for spotifyr::get_authorization_code() } diff --git a/man/search_spotify.Rd b/man/search_spotify.Rd index 7e2d16d..ea4a5ad 100644 --- a/man/search_spotify.Rd +++ b/man/search_spotify.Rd @@ -1,19 +1,12 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/search.R +% tinyrox says don't edit this manually, but it can't stop you! \name{search_spotify} \alias{search_spotify} \title{Search for an item} \usage{ -search_spotify( - q, - type = c("album", "artist", "playlist", "track"), - market = NULL, - limit = 20, - offset = 0, - include_external = NULL, - authorization = get_spotify_access_token(), - include_meta_info = FALSE -) +search_spotify(q, type = c("album", "artist", "playlist", "track"), + market = NULL, limit = 20, offset = 0, include_external = NULL, + authorization = get_spotify_access_token(), + include_meta_info = FALSE) } \arguments{ \item{q}{Required. \cr diff --git a/man/seek_to_position.Rd b/man/seek_to_position.Rd index 4285b4f..b75635e 100644 --- a/man/seek_to_position.Rd +++ b/man/seek_to_position.Rd @@ -1,14 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/player.R +% tinyrox says don't edit this manually, but it can't stop you! \name{seek_to_position} \alias{seek_to_position} \title{Seeks to the given position in the user’s currently playing track.} \usage{ -seek_to_position( - position_ms, - device_id = NULL, - authorization = get_spotify_authorization_code() -) +seek_to_position(position_ms, device_id = NULL, + authorization = get_spotify_authorization_code()) } \arguments{ \item{position_ms}{Required. Integer indicating the position in milliseconds to seek to. Must be a positive number. Passing in a position that is greater than the length of the track will cause the player to start playing the next song.} diff --git a/man/set_my_repeat_mode.Rd b/man/set_my_repeat_mode.Rd index 456c5ef..8cde1cb 100644 --- a/man/set_my_repeat_mode.Rd +++ b/man/set_my_repeat_mode.Rd @@ -1,14 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/player.R +% tinyrox says don't edit this manually, but it can't stop you! \name{set_my_repeat_mode} \alias{set_my_repeat_mode} \title{Set the repeat mode for the user’s playback. Options are repeat-track, repeat-context, and off.} \usage{ -set_my_repeat_mode( - state, - device_id = NULL, - authorization = get_spotify_authorization_code() -) +set_my_repeat_mode(state, device_id = NULL, + authorization = get_spotify_authorization_code()) } \arguments{ \item{state}{Required. \cr diff --git a/man/set_my_volume.Rd b/man/set_my_volume.Rd index 4ea5852..9a82bc8 100644 --- a/man/set_my_volume.Rd +++ b/man/set_my_volume.Rd @@ -1,14 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/player.R +% tinyrox says don't edit this manually, but it can't stop you! \name{set_my_volume} \alias{set_my_volume} \title{Set the volume for the user’s current playback device.} \usage{ -set_my_volume( - volume_percent, - device_id = NULL, - authorization = get_spotify_authorization_code() -) +set_my_volume(volume_percent, device_id = NULL, + authorization = get_spotify_authorization_code()) } \arguments{ \item{volume_percent}{Required. Integer. The volume to set. Must be a value from 0 to 100 inclusive.} diff --git a/man/skip_my_playback.Rd b/man/skip_my_playback.Rd index 0d0fabb..148c791 100644 --- a/man/skip_my_playback.Rd +++ b/man/skip_my_playback.Rd @@ -1,13 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/player.R +% tinyrox says don't edit this manually, but it can't stop you! \name{skip_my_playback} \alias{skip_my_playback} \title{Skips to next track in the user’s queue.} \usage{ -skip_my_playback( - device_id = NULL, - authorization = get_spotify_authorization_code() -) +skip_my_playback(device_id = NULL, + authorization = get_spotify_authorization_code()) } \arguments{ \item{device_id}{Optional. The id of the device this command is targeting. If not supplied, the user’s currently active device is the target.} diff --git a/man/skip_my_playback_previous.Rd b/man/skip_my_playback_previous.Rd index ad8479d..b17b7d1 100644 --- a/man/skip_my_playback_previous.Rd +++ b/man/skip_my_playback_previous.Rd @@ -1,13 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/player.R +% tinyrox says don't edit this manually, but it can't stop you! \name{skip_my_playback_previous} \alias{skip_my_playback_previous} \title{Skips to previous track in the user’s queue.} \usage{ -skip_my_playback_previous( - device_id = NULL, - authorization = get_spotify_authorization_code() -) +skip_my_playback_previous(device_id = NULL, + authorization = get_spotify_authorization_code()) } \arguments{ \item{device_id}{Optional. The id of the device this command is targeting. If not supplied, the user’s currently active device is the target.} diff --git a/man/start_my_playback.Rd b/man/start_my_playback.Rd index c9ff61c..dc3e16c 100644 --- a/man/start_my_playback.Rd +++ b/man/start_my_playback.Rd @@ -1,17 +1,11 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/player.R +% tinyrox says don't edit this manually, but it can't stop you! \name{start_my_playback} \alias{start_my_playback} \title{Skips to previous track in the user’s queue.} \usage{ -start_my_playback( - device_id = NULL, - context_uri = NULL, - uris = NULL, - offset = NULL, - position_ms = NULL, - authorization = get_spotify_authorization_code() -) +start_my_playback(device_id = NULL, context_uri = NULL, uris = NULL, + offset = NULL, position_ms = NULL, + authorization = get_spotify_authorization_code()) } \arguments{ \item{device_id}{Optional. The id of the device this command is targeting. If not supplied, the user’s currently active device is the target.} diff --git a/man/tinyspotifyr-package.Rd b/man/tinyspotifyr-package.Rd new file mode 100644 index 0000000..e0c725c --- /dev/null +++ b/man/tinyspotifyr-package.Rd @@ -0,0 +1,11 @@ +% tinyrox says don't edit this manually, but it can't stop you! +\docType{package} +\name{tinyspotifyr-package} +\alias{tinyspotifyr} +\alias{tinyspotifyr-package} +\title{\packageTitle{tinyspotifyr}} +\description{\packageDescription{tinyspotifyr}} +\section{Package Content}{\packageIndices{tinyspotifyr}} +\author{\packageAuthor{tinyspotifyr}} +\section{Maintainer}{\packageMaintainer{tinyspotifyr}} +\keyword{internal} diff --git a/man/tinyspotifyr.Rd b/man/tinyspotifyr.Rd deleted file mode 100644 index 78107d6..0000000 --- a/man/tinyspotifyr.Rd +++ /dev/null @@ -1,13 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/tinyspotifyr.R -\docType{package} -\name{tinyspotifyr} -\alias{tinyspotifyr} -\title{\code{tinyspotifyr} package} -\description{ -A Quick and Easy Wrapper for Spotify's Web API -} -\details{ -See the README on -\href{https://github.com/troyhernandez/tinyspotifyr#readme}{GitHub} -} diff --git a/man/toggle_my_shuffle.Rd b/man/toggle_my_shuffle.Rd index 647f504..b3546b8 100644 --- a/man/toggle_my_shuffle.Rd +++ b/man/toggle_my_shuffle.Rd @@ -1,14 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/player.R +% tinyrox says don't edit this manually, but it can't stop you! \name{toggle_my_shuffle} \alias{toggle_my_shuffle} \title{Toggle shuffle on or off for user’s playback.} \usage{ -toggle_my_shuffle( - state, - device_id = NULL, - authorization = get_spotify_authorization_code() -) +toggle_my_shuffle(state, device_id = NULL, + authorization = get_spotify_authorization_code()) } \arguments{ \item{state}{Required. \cr diff --git a/man/transfer_my_playback.Rd b/man/transfer_my_playback.Rd index 2ec604d..664d6bf 100644 --- a/man/transfer_my_playback.Rd +++ b/man/transfer_my_playback.Rd @@ -1,14 +1,10 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/player.R +% tinyrox says don't edit this manually, but it can't stop you! \name{transfer_my_playback} \alias{transfer_my_playback} \title{Transfer playback to a new device and determine if it should start playing.} \usage{ -transfer_my_playback( - device_ids, - play = FALSE, - authorization = get_spotify_authorization_code() -) +transfer_my_playback(device_ids, play = FALSE, + authorization = get_spotify_authorization_code()) } \arguments{ \item{device_ids}{Required. A character vector containing the ID of the device this on which playback should be started/transferred. Note: only a single device_id is currently supported.} diff --git a/man/unfollow_playlist.Rd b/man/unfollow_playlist.Rd index 99f28ca..2c7cd7a 100644 --- a/man/unfollow_playlist.Rd +++ b/man/unfollow_playlist.Rd @@ -1,13 +1,9 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/follow.R +% tinyrox says don't edit this manually, but it can't stop you! \name{unfollow_playlist} \alias{unfollow_playlist} \title{Remove the current user as a follower of a playlist.} \usage{ -unfollow_playlist( - playlist_id, - authorization = get_spotify_authorization_code() -) +unfollow_playlist(playlist_id, authorization = get_spotify_authorization_code()) } \arguments{ \item{playlist_id}{Required. The \href{https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids}{Spotify ID} of the playlist that is to be no longer followed.} diff --git a/man/verify_result.Rd b/man/verify_result.Rd index 7cbf286..038d2e4 100644 --- a/man/verify_result.Rd +++ b/man/verify_result.Rd @@ -1,5 +1,4 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/utils.R +% tinyrox says don't edit this manually, but it can't stop you! \name{verify_result} \alias{verify_result} \title{Verify API result}