added structure section
Sim1Pall8a authored on 21/07/2021 10:02:18
• GitHub committed on 21/07/2021 10:02:18
| ... | ... |
@@ -12,6 +12,43 @@ The library requires the following: |
| 12 | 12 |
|
| 13 | 13 |
It is recommended the use ot the latest version of RStudio. |
| 14 | 14 |
|
| 15 |
+## Structure |
|
| 16 |
+``` |
|
| 17 |
+RGMQL/ |
|
| 18 |
+|-- Example of workflows/ |
|
| 19 |
+|-- R/ |
|
| 20 |
+|-- inst/ |
|
| 21 |
+| |-- example/ |
|
| 22 |
+| |-- NEWS |
|
| 23 |
+|-- man/ |
|
| 24 |
+|-- vignettes/ |
|
| 25 |
+| |-- RGMQL-vignette.R |
|
| 26 |
+| |-- RGMQL-vignette.Rmd |
|
| 27 |
+| |-- RGMQL-vignette.html |
|
| 28 |
+| |-- american-medical-association-no-et-al.csl |
|
| 29 |
+| |-- bibliography.bib |
|
| 30 |
+| |-- .... |
|
| 31 |
+|-- DESCRIPTION |
|
| 32 |
+|-- NAMESPACE |
|
| 33 |
+|-- README.md |
|
| 34 |
+``` |
|
| 35 |
+ |
|
| 36 |
+- [Example of workflows](Example%20of%20workflows)/ folder containig various use cases |
|
| 37 |
+- [R](R)/ folder containing all the script files |
|
| 38 |
+- [inst](inst)/ folder containing all files that should be copied into the installed R package folder. |
|
| 39 |
+- [inst/example](inst/example) folder containing the datasets and other files in order to run correctly all the test. |
|
| 40 |
+- [inst/NEWS](inst/NEWS) file report the feature/changes/bugfix for each version. |
|
| 41 |
+- [man](man)/ folder containing R documentation files |
|
| 42 |
+- [vignettes](vignettes)/ folder containing all the files used to generate correctly the vignette |
|
| 43 |
+- [vignettes/RGMQL-vignette.R](vignettes/RGMQL-vignette.R) long-form guide to your package |
|
| 44 |
+- [vignettes/RGMQL-vignette.Rmd](vignettes/RGMQL-vignette.Rmd) the vignettes in markup language |
|
| 45 |
+- [vignettes/RGMQL-vignette.html](vignettes/RGMQL-vignette.html) the vignettes in html |
|
| 46 |
+- [vignettes/bibliography.bib](vignettes/bibliography.bib) the bibliographic or list of reference file used in vignette |
|
| 47 |
+- [vignettes/american-medical-association-no-et-al.csl](vignettes/american-medical-association-no-et-al.csl) the citation style language used in vignette |
|
| 48 |
+- [DESCRIPTION](DESCRIPTION) this file store important/mandatory metadata about RGMQL package. |
|
| 49 |
+- [NAMESPACE](NAMESPACE) this file make your packages self-contained, ensuring that other packages won’t interfere with your code, that your code won’t interfere with other packages, and that your package works regardless of the environment in which it’s run. |
|
| 50 |
+ |
|
| 51 |
+ |
|
| 15 | 52 |
## OSX Settings |
| 16 | 53 |
|
| 17 | 54 |
#### before Catalina |