buildNames {conjurer}R Documentation

Generate Names

Description

Generates names based on a given training data or using the default data

Usage

buildNames(dframe, numOfNames, minLength, maxLength)

Arguments

dframe

A dataframe. This argument is passed on to another function genMatrix for generating an alphabet frequency table. This dataframe is single column dataframe with rows that contain names. These names must only contain english alphabets(upper or lower case) from A to Z.

numOfNames

A numeric. This specifies the number of names to be generated. It should be non-zero natural number.

minLength

A numeric. This specifies the minimum number of alphabets in the name. It must be a non-zero natural number.

maxLength

A numeric. This specifies the maximum number of alphabets in the name. It must be a non-zero natural number.

Details

This function generates names. There are two options to generate names. The first option is to use an existing sample of names and generate names. The second option is to use the default table of prior probabilities.

Value

A list of names.

Examples

buildNames(numOfNames = 3, minLength = 5, maxLength = 7)

[Package conjurer version 1.5.0 Index]