generate_population: Call PopGen Web Service

Description Usage Arguments Details Value See Also Examples

Description

Sample a population dataset using PopGen.

Usage

1
generate_population(parameters, silent = FALSE)

Arguments

parameters

Inputs that describe the target population

silent

Whether or not to print activity messages during the call

Details

Use of this API requires an active account on the PopGen web site.

The returned object consists either of an XML document fragment containing the generated population, or one or more error messages.

Value

A structure containing data returned by the PopGen service.

See Also

Query outcome of service call with generate_succeeded. Retrieve results with extract_individuals.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Set PopGen account name
parameters <- list(
  PopGenUserName = "kevin.soandso@some.sci.org",
  PopulationSize = 100
  )

# Add typical values for other inputs
parameters <- apply_defaults(parameters)

# Call web service
pop_gen_out <- generate_population(parameters)

HSL/Rpgcli documentation built on May 31, 2019, 8:41 a.m.