fixes for R CMD check

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: aws.ec2
 Type: Package
 Title: Amazon Web Services EC2 Client Package
-Version: 0.1.13
-Date: 2018-06-02
+Version: 0.1.14
+Date: 2018-07-24
 Authors@R: c(person("Thomas J.", "Leeper", role = c("aut", "cre"),
                     email = "[email protected]",
                     comment = c(ORCID = "0000-0003-4097-6326")),

R/Instances.R

@@ -1,31 +1,18 @@
 #' @title Run an EC2 Instance
 #' @description Run/launch a new EC2 Instance
 #' @template image
-#' @param type A character string specifying the type of EC2 instance to use.
-#'   See
-#'   <http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html>
-#'   for details of types and available options.
-#' @param min An integer specifying a minimum number of instances to launch.
-#'   Defaults to 1.
-#' @param max An integer specifying a minimum number of instances to launch.
-#'   Defaults to `min`.
+#' @param type A character string specifying the type of EC2 instance to use. See <http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html> for details of types and available options.
+#' @param min An integer specifying a minimum number of instances to launch. Defaults to 1.
+#' @param max An integer specifying a minimum number of instances to launch. Defaults to `min`.
 #' @template keypair
 #' @template subnet
 #' @template sgroup
-#' @param userdata Optionally, a character string specifying a script to run
-#'   during launch.
-#' @param shutdown A character string specifying either \dQuote{stop} or
-#'   \dQuote{terminate}, to control the behavior of a shutdown action taken from
-#'   within the instance.
+#' @param userdata Optionally, a character string specifying a script to run during launch.
+#' @param shutdown A character string specifying either \dQuote{stop} or \dQuote{terminate}, to control the behavior of a shutdown action taken from within the instance.
 #' @template token
-#' @param spot_options Optionally, an empty `list()` to request a spot instance
-#'   with API defaults, or list of spot-market options. See
-#'   <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotMarketOptions.html>
-#'   for available options
-#' @param query_extra Optionally, additional query parameters to be passed to
-#'   the RunInstances API. See
-#'   <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html>
-#'   for available parameters.
+#' @param tags A named list of tags.
+#' @param spot_options Optionally, an empty `list()` to request a spot instance with API defaults, or list of spot-market options. See <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotMarketOptions.html> for available options
+#' @param query_extra Optionally, additional query parameters to be passed to the RunInstances API. See <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html> for available parameters.
 #'@param launch_template LaunchTemplate
 #' @template dots
 #' @return A list
@@ -50,9 +37,23 @@
 #' @keywords instances
 #' @export
 run_instances <- 
-function(image, type, min = 1, max = min, keypair, subnet, sgroup, 
-         userdata, shutdown = c("stop", "terminate"), token, tags,
-         spot_options, query_extra=list(), launch_template, ...) {
+function(
+  image,
+  type,
+  min = 1,
+  max = min,
+  keypair,
+  subnet,
+  sgroup,
+  userdata,
+  shutdown = c("stop", "terminate"),
+  token,
+  tags,
+  spot_options,
+  query_extra = list(),
+  launch_template,
+  ...
+) {
     query <- list(Action = "RunInstances", 
                   ImageId = get_imageid(image),
                   InstanceType = type,
@@ -85,19 +86,19 @@ function(image, type, min = 1, max = min, keypair, subnet, sgroup,
         query$ClientToken <- token
     }
     if (!missing(spot_options) && !is.null(spot_options)) {
-      query$InstanceMarketOptions.MarketType <- "spot"
-      if (length(spot_options)) {
-        names(spot_options) <- paste0("InstanceMarketOptions.SpotOptions.",names(spot_options))
-        query <- c(query, spot_options) 
-      }
+        query$InstanceMarketOptions.MarketType <- "spot"
+        if (length(spot_options)) {
+            names(spot_options) <- paste0("InstanceMarketOptions.SpotOptions.",names(spot_options))
+            query <- c(query, spot_options) 
+        }
     }
     if (!missing(launch_template) && !is.null(launch_template)) {
-      names(launch_template) <- "LaunchTemplate"
-      query <- c(query, launch_template)
+        names(launch_template) <- "LaunchTemplate"
+        query <- c(query, launch_template)
     }
     if (!missing(tags) && !is.null(tags)) {
-      tags <- .tag_specification(resource_type = "instance", tags)
-      query <- c(query, tags)
+        tags <- .tag_specification(resource_type = "instance", tags)
+        query <- c(query, tags)
     }
     query <- c(query, query_extra)
     r <- ec2HTTP(query = query, ...)

README.md

@@ -0,0 +1,126 @@
+# AWS EC2 Client Package
+
+**aws.ec2** is a simple client package for the Amazon Web Services (AWS) [Elastic Cloud Compute (EC2)](http://aws.amazon.com/ec2/) REST API, which can be used to monitor use of AWS web services.
+
+To use the package, you will need an AWS account and to enter your credentials into R. Your keypair can be generated on the [IAM Management Console](https://aws.amazon.com/) under the heading *Access Keys*. Note that you only have access to your secret key once. After it is generated, you need to save it in a secure location. New keypairs can be generated at any time if yours has been lost, stolen, or forgotten. The [**aws.iam** package](https://github.com/cloudyr/aws.iam) profiles tools for working with IAM, including creating roles, users, groups, and credentials programmatically; it is not needed to *use* IAM credentials.
+
+By default, all **cloudyr** packages for AWS services allow the use of credentials specified in a number of ways, beginning with:
+
+ 1. User-supplied values passed directly to functions.
+ 2. Environment variables, which can alternatively be set on the command line prior to starting R or via an `Renviron.site` or `.Renviron` file, which are used to set environment variables in R during startup (see `? Startup`). Or they can be set within R:
+
+    ```R
+    Sys.setenv("AWS_ACCESS_KEY_ID" = "mykey",
+               "AWS_SECRET_ACCESS_KEY" = "mysecretkey",
+               "AWS_DEFAULT_REGION" = "us-east-1",
+               "AWS_SESSION_TOKEN" = "mytoken")
+    ```
+ 3. If R is running an EC2 instance, the role profile credentials provided by [**aws.ec2metadata**](https://cran.r-project.org/package=aws.ec2metadata).
+ 4. Profiles saved in a `/.aws/credentials` "dot file" in the current working directory. The `"default" profile is assumed if none is specified.
+ 5. [A centralized `~/.aws/credentials` file](https://blogs.aws.amazon.com/security/post/Tx3D6U6WSFGOK2H/A-New-and-Standardized-Way-to-Manage-Credentials-in-the-AWS-SDKs), containing credentials for multiple accounts. The `"default" profile is assumed if none is specified.
+
+Profiles stored locally or in a centralized location (e.g., `~/.aws/credentials`) can also be invoked via:
+
+```R
+# use your 'default' account credentials
+aws.signature::use_credentials()
+
+# use an alternative credentials profile
+aws.signature::use_credentials(profile = "bob")
+```
+
+Temporary session tokens are stored in environment variable `AWS_SESSION_TOKEN` (and will be stored there by the `use_credentials()` function). The [aws.iam package](https://github.com/cloudyr/aws.iam/) provides an R interface to IAM roles and the generation of temporary session tokens via the security token service (STS).
+
+## Code Examples
+
+The basic idea of the package is to be able to launch and control EC2 instances. You can read [this blog post from AWS](https://blogs.aws.amazon.com/bigdata/post/Tx3IJSB6BMHWZE5/Running-R-on-AWS) about how to run R on EC2.
+
+A really simple example is to launch an instance that comes preloaded with an RStudio Server Amazon Machine Image ([AMI](http://www.louisaslett.com/RStudio_AMI/)):
+
+
+```r
+# Describe the AMI (from: http://www.louisaslett.com/RStudio_AMI/)
+image <- "ami-b1b0c3c2"
+describe_images(image)
+```
+
+```
+## Error in describe_images(image): could not find function "describe_images"
+```
+
+```r
+# Check your VPC and Security Group settings
+s <- describe_subnets()
+```
+
+```
+## Error in describe_subnets(): could not find function "describe_subnets"
+```
+
+```r
+g <- describe_sgroups()
+```
+
+```
+## Error in describe_sgroups(): could not find function "describe_sgroups"
+```
+
+```r
+# Launch the instance using appropriate settings
+i <- run_instances(image = image, 
+                   type = "t2.micro", # <- you might want to change this
+                   subnet = s[[1]], 
+                   sgroup = g[[1]])
+```
+
+```
+## Error in run_instances(image = image, type = "t2.micro", subnet = s[[1]], : could not find function "run_instances"
+```
+
+```r
+# RStudio Server will be available at the "publicIp" address returned in `i`
+# Note: the default security settings prohibit outbound traffic
+
+# Stop and terminate the instances
+stop_instances(i[[1]])
+```
+
+```
+## Error in stop_instances(i[[1]]): could not find function "stop_instances"
+```
+
+```r
+terminate_instances(i[[1]])
+```
+
+```
+## Error in terminate_instances(i[[1]]): could not find function "terminate_instances"
+```
+
+
+## Installation
+
+[![CRAN](https://www.r-pkg.org/badges/version/aws.ec2)](https://cran.r-project.org/package=aws.ec2)
+![Downloads](https://cranlogs.r-pkg.org/badges/aws.ec2)
+[![Travis Build Status](https://travis-ci.org/cloudyr/aws.ec2.png?branch=master)](https://travis-ci.org/cloudyr/aws.ec2)
+[![codecov.io](https://codecov.io/github/cloudyr/aws.ec2/coverage.svg?branch=master)](https://codecov.io/github/cloudyr/aws.ec2?branch=master)
+
+This package is not yet on CRAN. To install the latest development version you can install from the cloudyr drat repository:
+
+```R
+# latest stable version
+install.packages("aws.ec2", repos = c(getOption("repos"), "http://cloudyr.github.io/drat"))
+```
+
+Or, to pull a potentially unstable version directly from GitHub:
+
+```R
+if(!require("remotes")){
+    install.packages("remotes")
+}
+remotes::install_github("cloudyr/aws.ec2")
+```
+
+
+---
+[![cloudyr project logo](http://i.imgur.com/JHS98Y7.png)](https://github.com/cloudyr)

aws.ec2.Rproj

@@ -6,7 +6,7 @@ AlwaysSaveHistory: Default
 
 EnableCodeIndexing: Yes
 UseSpacesForTab: Yes
-NumSpacesForTab: 2
+NumSpacesForTab: 4
 Encoding: UTF-8
 
 RnwWeave: Sweave