insert_script_description: Insert script description
In MirzaCengic/Rahat:

Description Usage Arguments Value Examples

View source: R/insert_script_description.R

Use this function to insert template used to give some basic information on the current R script to its top. This function will only work in RStudio, as it uses rstudioapi package to add text.

insert_script_description(script_title = "Script title",
  project_title = "My research project",
  script_type = "Data processing", script_description = "Description",
  script_date = Rahat::today(format = "human"),
  creator_name = "Mirza Cengic", creator_email = "mirzaceng@gmail.com")

`script_title`	Character. Script title.
`project_title`	Character. To which project does script relate to.
`script_type`	Character. Type of script. Eg. data analysis, modeling, plotting.
`script_description`	Character. What it does, and why, in more detial.
`script_date`	Character. Default is Day, Month Year.
`creator_name`	Character. Default is "Mirza Cengic".
`creator_email`	Character. Default is "mirzaceng@gmail.com"