get_latest_change: Write data-time and user that has done latest changes to a...

View source: R/misc_helper.R

get_latest_changeR Documentation

Write data-time and user that has done latest changes to a document

Description

The information about who has done the latest changes to a document is usually added at the end of a website. This allows the reader of a website to check whether the site was recently updated. For the author, it is an easy way to check whether the most recent version has been uploaded to the server.

Usage

get_latest_change(ps_msg = "Latest Changes")

Arguments

ps_msg

special message to be used in front of time and user info, defaults to Latest Changes

Details

The information that is returned by this function consists of the time returned by Sys.time() and the username that is returned by Sys.info(). The intended way to use this function is to cat() the result of the function in the last code-junk of a document. See examples for more details.

Value

st_result containing time and user-part of system info

Examples

## Not run: 
```{r}
cat(rmddochelper::get_latest_change(), "\n")
```

## End(Not run)


charlotte-ngs/rmdhelp documentation built on Oct. 31, 2023, 10:21 a.m.