draft.readme: Draft Readme
| draft.readme | R Documentation |
Draft Readme
Description
Draft an introductory README.md that describes how to run a TAF
analysis.
Usage
draft.readme(title = NULL, file = "")
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
|
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.
Value
Character vector of class Bibtex.
Note
Although the output is Markdown text, the Bibtex class is used for
convenient display in the console.
See Also
git.repo reads the Git repository name.
TAF-package gives an overview of the package.
Examples
## Not run:
# Print in console
draft.readme()
# Export to file
draft.readme(file=TRUE)
# Specify title
draft.readme("Yellowfin tuna in the western and central Pacific")
## End(Not run)
