TAF (version 4.3.0)

draft.readme: Draft Readme

Description

Draft an introductory README.md that describes how to run a TAF analysis.

Usage

draft.readme(title = NULL, file = "")

Value

Character vector of class Bibtex.

Arguments

title

title to display at the top of the `README.md` page.

file

optional filename to save the draft readme to a file. The value TRUE can be used as shorthand for "README.md".

Details

The default value title = NULL uses the Git repository name as a placeholder title.

The default value file = "" prints the initial draft in the console, instead of writing it to a file. The output can then be pasted into a file to edit further, without accidentally overwriting an existing file.

See Also

git.repo reads the Git repository name.

TAF-package gives an overview of the package.

Examples

if (FALSE) {
# Print in console
draft.readme()

# Export to file
draft.readme(file=TRUE)

# Specify title
draft.readme("Yellowfin tuna in the western and central Pacific")
}