AWSSnowParam: AWSSnowParam function to start an AWS EC2-instance cluster

Description Usage Arguments Value Examples

View source: R/AWSSnowParam-class.R

Description

This function starts a cluster of AWS EC2-instances to allow parallel computation of R objects, and works with BiocParallel, to allow computation with R/Bioconductor objects

Usage

1
2
3
4
5
6
7
AWSSnowParam(workers = 2, awsCredentialsPath = NA_character_,
  awsInstanceType = NA_character_, awsSubnet = NA, awsSecurityGroup = NA,
  awsAmiId = NA_character_, awsSshKeyPair = NA_character_,
  awsProfile = "default", user = "ubuntu", rhome = "/usr/local/lib/R",
  bplib = "/home/ubuntu/R/x86_64-pc-linux-gnu-library/3.4/BiocParallel",
  rscript = "/usr/local/bin/Rscript", outfile = "/home/ubuntu/snow.log",
  verbose = FALSE)

Arguments

workers

Numeric, number of workers to launch in the cluster

awsCredentialsPath

character, Path to AWS credentials, default value is '~/.aws/credentials'

awsInstanceType

character, Type of AWS EC2-instance, eg. t2.micro

awsSubnet

character, AWS EC2-instance subnet, within a certain VPC

awsSecurityGroup

character, Security group which assigns inbound and outbound traffic at the instance level. The security group needs to be *Inbound rules* Protocol type Port number Source IP TCP 22 (SSH) 0.0.0.0/0 TCP 11000-11999 CIDR-Block same as VPC *Outbound rules* Protocol type Port number Destination IP All All 0.0.0.0/0

awsAmiId

character, AMI(amazon machine image) ID for the Bioconductor-release version

awsSshKeyPair

character, SSH key pair, to associate with your AWS EC2-instance

awsProfile

character, indicates what profile to use while using AWS credentials

verbose

logical, gives a verbose output of SSH connection attempt, default is FALSE.

Value

AWSSnowParam object

Examples

1
2
3
4
5
6
7
8
## Not run: 
        ## Minimal example
        aws <- AWSSnowParam(workers = 1,
               awsInstanceType="t2.micro",
               awsAmiId= image,
               awsSshKeyPair = "~/.ssh/<my_aws_key_pair>.pub")

## End(Not run)

Bioconductor/AWSParallel documentation built on May 28, 2019, 11:58 a.m.