diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml
index 1ce5c78..e47c799 100644
--- a/.github/workflows/R-CMD-check.yaml
+++ b/.github/workflows/R-CMD-check.yaml
@@ -64,6 +64,7 @@ jobs:
- uses: r-lib/actions/check-r-package@v2
with:
+ args: 'c("--no-examples", "--no-manual", "--as-cran")'
upload-snapshots: true
env:
AWS_REGION: us-west-2
diff --git a/NAMESPACE b/NAMESPACE
index 4bc951a..579aeb4 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -1,6 +1,7 @@
# Generated by roxygen2: do not edit by hand
S3method(print,sixtyfour_client)
+export("%>%")
export(as_policy_arn)
export(aws_billing)
export(aws_billing_raw)
diff --git a/R/groups.R b/R/groups.R
index a2ce3bc..da11b11 100644
--- a/R/groups.R
+++ b/R/groups.R
@@ -20,10 +20,9 @@ group_list_tidy <- function(x) {
#' if username is non-NULL, otherwise passed on to `list_users`
#' @return A tibble with information about groups
#' @family groups
-#' @examples \dontrun{
+#' @examplesIf aws_has_creds()
#' aws_groups()
#' aws_groups(username = aws_user_current())
-#' }
aws_groups <- function(username = NULL, ...) {
if (is.null(username)) {
paginate_aws_marker("list_groups", "Groups", ...) %>%
@@ -48,9 +47,13 @@ aws_groups <- function(username = NULL, ...) {
#' @details see docs
#' @autoglobal
#' @family groups
-#' @examples \dontrun{
-#' aws_group(name = "users")
-#' }
+#' @examplesIf aws_has_creds()
+#' # create a group
+#' aws_group_create("testing")
+#' # get the group
+#' aws_group(name = "testing")
+#' # cleanup
+#' aws_group_delete(name = "testing")
aws_group <- function(name) {
x <- con_iam()$get_group(name)
list(
@@ -63,18 +66,21 @@ aws_group <- function(name) {
#' Check if a group exists
#'
+#' @importFrom purrr safely
#' @export
#' @param name (character) the group name
#' @return a single boolean
#' @details uses `aws_group` internally. see docs
#'
#' @family groups
-#' @examples \dontrun{
-#' aws_group_exists(name = "users")
-#' aws_group_exists(name = "apples")
-#' }
+#' @examplesIf aws_has_creds()
+#' aws_group_create("apples")
+#' aws_group_exists("apples")
+#' aws_group_exists("doesnotexist")
+#' # cleanup
+#' aws_group_delete("apples")
aws_group_exists <- function(name) {
- check_aws_group <- purrr::safely(aws_group, otherwise = FALSE)
+ check_aws_group <- safely(aws_group, otherwise = FALSE)
is.null(check_aws_group(name)$error)
}
@@ -88,9 +94,11 @@ aws_group_exists <- function(name) {
#' @details See
#' docs for details on the parameters
#' @family groups
-#' @examples \dontrun{
-#' aws_group_create("testgroup")
-#' }
+#' @examplesIf aws_has_creds()
+#' aws_group_create("testingagroup")
+#' aws_group("testingagroup")
+#' # cleanup
+#' aws_group_delete("testingagroup")
aws_group_create <- function(name, path = NULL) {
con_iam()$create_group(Path = path, GroupName = name) %>%
group_list_tidy()
@@ -104,9 +112,9 @@ aws_group_create <- function(name, path = NULL) {
#' @details See
#' docs for more details
#' @family groups
-#' @examples \dontrun{
-#' aws_group_delete(name = "testgroup")
-#' }
+#' @examplesIf aws_has_creds()
+#' aws_group_create("somegroup")
+#' aws_group_delete("somegroup")
aws_group_delete <- function(name) {
con_iam()$delete_group(name)
}
diff --git a/R/reexport-magrittr.R b/R/reexport-magrittr.R
new file mode 100644
index 0000000..ce0b79e
--- /dev/null
+++ b/R/reexport-magrittr.R
@@ -0,0 +1,3 @@
+#' @importFrom magrittr %>%
+#' @export
+magrittr::`%>%`
diff --git a/man/aws_group.Rd b/man/aws_group.Rd
index f0d8d93..5518902 100644
--- a/man/aws_group.Rd
+++ b/man/aws_group.Rd
@@ -25,9 +25,14 @@ Get a group
see docs \url{https://www.paws-r-sdk.com/docs/iam_get_group/}
}
\examples{
-\dontrun{
-aws_group(name = "users")
-}
+\dontshow{if (aws_has_creds()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
+# create a group
+aws_group_create("testing")
+# get the group
+aws_group(name = "testing")
+# cleanup
+aws_group_delete(name = "testing")
+\dontshow{\}) # examplesIf}
}
\seealso{
Other groups:
diff --git a/man/aws_group_create.Rd b/man/aws_group_create.Rd
index cc038d6..9f43bc3 100644
--- a/man/aws_group_create.Rd
+++ b/man/aws_group_create.Rd
@@ -23,9 +23,12 @@ See \url{https://www.paws-r-sdk.com/docs/iam_create_group/}
docs for details on the parameters
}
\examples{
-\dontrun{
-aws_group_create("testgroup")
-}
+\dontshow{if (aws_has_creds()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
+aws_group_create("testingagroup")
+aws_group("testingagroup")
+# cleanup
+aws_group_delete("testingagroup")
+\dontshow{\}) # examplesIf}
}
\seealso{
Other groups:
diff --git a/man/aws_group_delete.Rd b/man/aws_group_delete.Rd
index 2ac432a..4a9f3db 100644
--- a/man/aws_group_delete.Rd
+++ b/man/aws_group_delete.Rd
@@ -20,9 +20,10 @@ See \url{https://www.paws-r-sdk.com/docs/iam_delete_group/}
docs for more details
}
\examples{
-\dontrun{
-aws_group_delete(name = "testgroup")
-}
+\dontshow{if (aws_has_creds()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
+aws_group_create("somegroup")
+aws_group_delete("somegroup")
+\dontshow{\}) # examplesIf}
}
\seealso{
Other groups:
diff --git a/man/aws_group_exists.Rd b/man/aws_group_exists.Rd
index bddb4ad..641a26d 100644
--- a/man/aws_group_exists.Rd
+++ b/man/aws_group_exists.Rd
@@ -20,10 +20,13 @@ uses \code{aws_group} internally. see docs
\url{https://www.paws-r-sdk.com/docs/iam_get_group/}
}
\examples{
-\dontrun{
-aws_group_exists(name = "users")
-aws_group_exists(name = "apples")
-}
+\dontshow{if (aws_has_creds()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
+aws_group_create("apples")
+aws_group_exists("apples")
+aws_group_exists("doesnotexist")
+# cleanup
+aws_group_delete("apples")
+\dontshow{\}) # examplesIf}
}
\seealso{
Other groups:
diff --git a/man/aws_groups.Rd b/man/aws_groups.Rd
index 2ff7df3..8fd64af 100644
--- a/man/aws_groups.Rd
+++ b/man/aws_groups.Rd
@@ -19,10 +19,10 @@ A tibble with information about groups
List all groups or groups for a single user
}
\examples{
-\dontrun{
+\dontshow{if (aws_has_creds()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
aws_groups()
aws_groups(username = aws_user_current())
-}
+\dontshow{\}) # examplesIf}
}
\seealso{
Other groups:
diff --git a/man/reexports.Rd b/man/reexports.Rd
index 9693104..b314cc2 100644
--- a/man/reexports.Rd
+++ b/man/reexports.Rd
@@ -1,8 +1,9 @@
% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/reexport-s3fs.R
+% Please edit documentation in R/reexport-magrittr.R, R/reexport-s3fs.R
\docType{import}
\name{reexports}
\alias{reexports}
+\alias{\%>\%}
\alias{s3_path}
\title{Objects exported from other packages}
\keyword{internal}
@@ -11,6 +12,8 @@ These objects are imported from other packages. Follow the links
below to see their documentation.
\describe{
+ \item{magrittr}{\code{\link[magrittr:pipe]{\%>\%}}}
+
\item{s3fs}{\code{\link[s3fs:path]{s3_path}}}
}}
diff --git a/man/sixtyfour-package.Rd b/man/sixtyfour-package.Rd
index e9e58b3..0b790b3 100644
--- a/man/sixtyfour-package.Rd
+++ b/man/sixtyfour-package.Rd
@@ -6,7 +6,7 @@
\alias{sixtyfour-package}
\title{sixtyfour: Humane Interface to AWS}
\description{
-An opionated interface to AWS, with methods for interacting with IAM, S3, RDS, Redshift, and Billing.
+An opinionated interface to AWS, with methods for interacting with 'IAM', S3, RDS, Redshift, and Billing.
}
\seealso{
Useful links: