Skip to content

areedv/bilfar

Repository files navigation

bilfar

Formålet med R-pakken bilfar er å lage rapporter i henhold til kontrollavtalene med andre land. Pakken bygger videre på det arbeidet som Trond H og Anna har gjort.

Målet er at rapportleveransen skal bli så enkel som mulig å utføre. Det gjelder både i manuell og automatisert gjennomføring av oppdraget

Bruk av R-pakken

I gjeldende versjon av pakken er det kun mulig å kjøre rapporteringsprosessen manuelt. Det vil si at R-pakken må installeres og aktuelle funksjoner må kjøres gjennom en terminal. Der er likevel slik at de fleste steg er "knyttet sammen" for å begrense omfanget av manuelt arbeid.

"Full" automatisering er avhengig av et miljø der pakken kan aktiveres av et "system" på definerte tidspunkter, eksempelvis én gang per månded. Et slikt miljø finnes kanskje allerede, men det dette er avklaringer som må gjøres sammen med våre IT-folk.

Installasjon

Det er ikke kjent om direktoratet har en egen "pakkebrønn" der bilfar kan gjøres tilgjengelig for direkte installasjon hos den enkelte. Inntil det er klart må koden klones fra bitbucket, eksempelvis ved bruk av ssh:

git clone ssh://git@stash.fiskeridirektoratet.no:7999/far/bilfar.git

Åpne en R-terminal, gå inn i bilfar-katalogen og installér pakken ved bruk av devtools-pakken:

devtools::install()

Funksjonene vil være tilgjengelig så snart pakken knyttes til R-sesjonen:

library("bilfar")

Kjøring av rapporter

Denne må vi komme tilbake til når flere av funksjonen er klare

Utvikling av R-pakken

Utvikling av R-pakken vil følge standard tilnærming:

  1. Lag en egen git-grein for endringen
  2. Gjør endringer og sjekk at alt fungerer
  3. Be en kollega se over ved å lage en "pull request"
  4. Når alle er enige, gjør en "merge" mot "main"-greina og slett utviklingsgreina

Dokumentasjon inngår som en integrert del av utviklingsprosessen og alle beskrivelser, eksempelvis det du leser nå, triller ut når utviklingen er ferdigstilt. Man slipper da å vedlikeholde egen dokumentasjon på siden, men ivaretar heller behovet som en del av standard utviklingsprosess. I dette tilfellet er dette vist for R, men veldig mange andre "språk" har tilsvarende verktøy for å ivareta behovet for produksjon og tilgjengeliggjøring av dokumentasjon.

About

Replica of restricted bitbucket

Resources

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages