diff --git a/_docs/contents/functions.qmd b/_docs/contents/functions.qmd index 2e28f82..078f609 100644 --- a/_docs/contents/functions.qmd +++ b/_docs/contents/functions.qmd @@ -39,7 +39,7 @@ Name of the folder which will store the website. \ A github url indicating where the documented files will be stored. It will create a link to the source code for each function. The default value will not create such links. \ * `run_examples` \ -If `TRUE`, All R code identified in an r code block will be evaluated in a separate R session. If you don't want a certain part +If `TRUE`, All R code identified in an R code block will be evaluated in a separate R session. If you don't want a certain part of the code to be run, it will be needed to comment it or avoid the r code representation in markdown. \ diff --git a/docs/contents/functions.html b/docs/contents/functions.html index a9ea02d..8ad316d 100644 --- a/docs/contents/functions.html +++ b/docs/contents/functions.html @@ -230,7 +230,7 @@

Arguments

A github url indicating where the documented files will be stored. It will create a link to the source code for each function. The default value will not create such links.
  • run_examples
    -If TRUE, All R code identified in an r code block will be evaluated in a separate R session. If you don’t want a certain part of the code to be run, it will be needed to comment it or avoid the r code representation in markdown.
    +If TRUE, All R code identified in an R code block will be evaluated in a separate R session. If you don’t want a certain part of the code to be run, it will be needed to comment it or avoid the r code representation in markdown.
    • diff --git a/docs/search.json b/docs/search.json index 454b034..d51ebe1 100644 --- a/docs/search.json +++ b/docs/search.json @@ -26,7 +26,7 @@ "href": "contents/functions.html#generate_docs", "title": "Functions", "section": "generate_docs", - "text": "generate_docs\ngenerate_docs(files, folder_name = \"docs\", gh_url = \"\", run_examples = FALSE) source \n\nGenerate a quarto website from lines starting with ### or /// that are right above function declarations.\nThe website folder is created in the current working directory.\nThe first line of the block is important, since the name of the variable will be used to group functions into the same one-worded section. This is useful, for example, when working using an OOP approach. For now, to avoid any bugs, it is important that all grouped functions are on the same file.\nThe user is free to create its headings, line breaks and make use of all other markdown utilities.\nAll R code identified by r code markdown blocks will be evaluated in a separate R session. If you don’t want a certain part of the code to be run, it will be needed to comment it or avoid the code block representation. If you don’t want to evaluate the code at all, use run_examples = FALSE, which is the default.\n\n\nArguments\n\nfiles\nThe files that will be used to create the .qmd documentation.\nfolder_name\nName of the folder which will store the website.\n\ngh_url\nA github url indicating where the documented files will be stored. It will create a link to the source code for each function. The default value will not create such links.\n\nrun_examples\nIf TRUE, All R code identified in an r code block will be evaluated in a separate R session. If you don’t want a certain part of the code to be run, it will be needed to comment it or avoid the r code representation in markdown.\n\n\n\n\nExamples\nrdocs::generate_docs(files = \"./rdocs/R/main.R\", folder_name = \"docs\", gh_url = \"https://github.com/daniellga/rdocs/tree/main/rdocs/R\", run_examples = FALSE)", + "text": "generate_docs\ngenerate_docs(files, folder_name = \"docs\", gh_url = \"\", run_examples = FALSE) source \n\nGenerate a quarto website from lines starting with ### or /// that are right above function declarations.\nThe website folder is created in the current working directory.\nThe first line of the block is important, since the name of the variable will be used to group functions into the same one-worded section. This is useful, for example, when working using an OOP approach. For now, to avoid any bugs, it is important that all grouped functions are on the same file.\nThe user is free to create its headings, line breaks and make use of all other markdown utilities.\nAll R code identified by r code markdown blocks will be evaluated in a separate R session. If you don’t want a certain part of the code to be run, it will be needed to comment it or avoid the code block representation. If you don’t want to evaluate the code at all, use run_examples = FALSE, which is the default.\n\n\nArguments\n\nfiles\nThe files that will be used to create the .qmd documentation.\nfolder_name\nName of the folder which will store the website.\n\ngh_url\nA github url indicating where the documented files will be stored. It will create a link to the source code for each function. The default value will not create such links.\n\nrun_examples\nIf TRUE, All R code identified in an R code block will be evaluated in a separate R session. If you don’t want a certain part of the code to be run, it will be needed to comment it or avoid the r code representation in markdown.\n\n\n\n\nExamples\nrdocs::generate_docs(files = \"./rdocs/R/main.R\", folder_name = \"docs\", gh_url = \"https://github.com/daniellga/rdocs/tree/main/rdocs/R\", run_examples = FALSE)", "crumbs": [ "Documentation", "Functions"