AWSBatchJobsParam: AWSBatchJobsParam function to start an AWS EC2-instance...

Description Usage Arguments Value Examples

View source: R/AWSBatchJobsParam-class.R

Description

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

Usage

1
2
3
4
5
6
AWSBatchJobsParam(workers = NULL,
  starclusterConfigPath = .STARCLUSTER_CONFIG_PATH,
  startclusterClusterId = "smallcluster", awsInstanceType = NA_character_,
  awsSubnet = NA_character_, awsAmiId = NA_character_,
  awsSshKeyPair = NA_character_, awsCredentialsPath = "~/.aws/credentials",
  awsProfile = "default", ...)

Arguments

workers

Numeric, number of workers to launch in the cluster

awsInstanceType

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

awsSubnet

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

awsAmiId

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

awsSshKeyPair

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

awsCredentialsPath

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

awsProfile

character, indicates what profile to use while using AWS credentials

...

Additional arguments, used to initialize BatchJobsParam.

verbose

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

Value

AWSBatchJobsparam object

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## Not run: 
        ## Minimal example
        aws <- AWSBatchJobsParam(
                   workers = 2
                   awsCredentialsPath = "~/.aws/credentials"
                   awsInstanceType = "t2.micro"
                   awsSubnet = "subnet-d66a05ec"
                   awsAmiId = "ami-0454187e"
                   awsSshKeyPair = "mykey"
               )

## End(Not run)

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