Skip to content

Structure

Sander Devisscher edited this page Apr 26, 2024 · 7 revisions

Tree

📦 fistools
.Rbuildignore
.github
│  └─ workflows
│     ├─ R-CMD-check.yaml
│     └─ test-coverage.yaml
├─ CODE_OF_CONDUCT.md
├─ .gitignore
DESCRIPTION
LICENSE
├─ LICENSE.md
NAMESPACE
├─ R
│  └─ scafold.txt
├─ README.md
├─ codemeta.json
├─ data
│  └─ scafold.txt
├─ data_raw
│  └─ scafold.txt
├─ src
│  └─ scafold.txt
├─ fistools.Rproj
└─ man
   └─ scafold.txt

©generated by Project Tree Generator

Root - files

.gitignore

Dit bestand bevat een lijst van bestanden, bestandtypes en mappen die door git genegeerd worden. Deze items worden dus niet gesynchroniseerd naar github online en zijn dus enkel lokaal beschikbaar.

DESCRIPTION

Dit bestand bevat een beschrijving van het package, een lijst van auteurs en het versienummer.

NAMESPACE

Dit automatisch gegenereerd bestand bevat info over de gebruikte packages. PAS DIT BESTAND NIET MANUEEL AAN in de plaats daarvan laat je roxygen2::roxygenise() lopen.

fistools.rproj

Het R-project van deze repo. Aanpassingen aan de code gebeuren steeds via het R-project.

Others

.Rbuildignore

...

Folders

R

Deze folder bevat de R-scripts van de functies van de package.

We hanteren de volgende regels:

  1. slechts 1 functie per bestand
  2. bestand naam is gelijk aan functienaam
  3. splits functies indien mogelijk

data

Deze folder bevat data bestanden die opgeroepen kunnen worden dmv de package.

Deze bestanden hebben steeds een .rda of .rds bestand extentie.

Nieuwere versies van dezelfde data worden best opgeslagen als lijst in het .rda bestand.

bvb de wbe_binnengrenzen worden best opgeslagen in wbe_binnengrenzen.rda en zullen als bvb fistools::wbe_binnengrenzen$2014 ingelezen kunnen worden.

src

Deze folder bevat de scripts om de ruwe data bestanden om te zetten naar .rda/.rds bestanden.

data_raw

Deze folder bevat de ruwe data bestanden vooraleer ze dmv scripts uit src omgezet worden naar .rda/.rds - bestanden.

man

Deze folder bevat automatisch gegenereerde documentatie obv de scripts in de R - folder.

Clone this wiki locally