diff --git a/DESCRIPTION b/DESCRIPTION index 5e79fd5..2f0dffa 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -46,6 +46,8 @@ Encoding: UTF-8 Roxygen: list(markdown = TRUE) RoxygenNote: 7.3.2 Suggests: + devtools, knitr, - rmarkdown + rmarkdown, + rmdformats VignetteBuilder: knitr diff --git a/example.R b/example.R deleted file mode 100644 index ac5bef5..0000000 --- a/example.R +++ /dev/null @@ -1,8 +0,0 @@ -library(NetworkDataCompanion) - - -#create object from NetworkDataCompanion class -obj <- CreateNetworkDataCompanionObject(argument_one = "hehehe") - - -obj$convertBetaToM \ No newline at end of file diff --git a/vignettes/demo.Rmd b/quickstart.Rmd similarity index 97% rename from vignettes/demo.Rmd rename to quickstart.Rmd index 4f02064..7791dfc 100644 --- a/vignettes/demo.Rmd +++ b/quickstart.Rmd @@ -5,7 +5,7 @@ output: rmdformats::robobook: code_folding: show toc_depth: 4 -bibliography: demo.bib +bibliography: quickstart.bib link-citations: true --- @@ -21,14 +21,14 @@ While none of these tasks are particularly complex, `NetworkDataCompanion` is mo # Preparing the workspace -The first step is to install `NetworkDataCompanion` from GitHub using the `devtools` library and the `install_github` function. +The first step is to install `NetworkDataCompanion` from GitHub using the `devtools` library and the `install_github` function. Here, we have suppressed messages as there are quite a few. -```{R} +```{R, message=F} library(devtools) devtools::install_github("QuackenbushLab/NetworkDataCompanion") ``` -Once you have installed the package, load the library into your workspace. Here, we have suppressed package loading messages as there are quite a few. +Once you have installed the package, load the library into your workspace. ```{R, message=F} library(NetworkDataCompanion) diff --git a/vignettes/demo.bib b/quickstart.bib similarity index 100% rename from vignettes/demo.bib rename to quickstart.bib