Merge pull request #30 from statisticsnorway/sjentoft-patch-2

Name change

.github/workflows/R-CMD-check.yaml

@@ -19,18 +19,18 @@ jobs:
       fail-fast: false
       matrix:
         config:
-          #- {os: windows-latest, r: 'release'}
-          #- {os: ubuntu-latest, r: 'release'}
-          - {os: ubuntu-latest, r: '4.2.3'}
+          - {os: windows-latest, r: 'release'}
+          - {os: ubuntu-latest, r: 'release'}
+          #- {os: ubuntu-latest, r: '4.2.3'}
           #- {os: ubuntu-latest, r: '3.6'}  
-          #- {os: macOS-latest, r: 'release'}
+          - {os: macOS-latest, r: 'release'}
 
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
       R_KEEP_PKG_SOURCE: yes
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: r-lib/actions/setup-pandoc@v2
 
@@ -42,7 +42,7 @@ jobs:
 
       - uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          extra-packages: any::sessioninfo, any::rcmdcheck, local::. 
+          extra-packages: any::sessioninfo, any::rcmdcheck, local::.
           needs: check
 
       - name: Session info

README.md

@@ -1,24 +1,28 @@
 
 # metodebiblioteket
 
-[![R-CMD-check](https://github.com/statisticsnorway/metodebiblioteket/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/statisticsnorway/metodebiblioteket/actions/workflows/R-CMD-check.yaml)
-[![pytest](https://github.com/statisticsnorway/metodebiblioteket/actions/workflows/pytest-check.yaml/badge.svg)](https://github.com/statisticsnorway/metodebiblioteket/actions/workflows/pytest.yaml)
+[![R-CMD-check](https://github.com/statisticsnorway/ssb-metodebiblioteket/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/statisticsnorway/ssb-metodebiblioteket/actions/workflows/R-CMD-check.yaml)
+[![pytest](https://github.com/statisticsnorway/ssb-metodebiblioteket/actions/workflows/pytest-check.yaml/badge.svg)](https://github.com/statisticsnorway/ssb-metodebiblioteket/actions/workflows/pytest.yaml)
 
 Denne repo-en inneholder informasjon om funksjoner som danne SSBs
 Metodebiblioteket. Du kan se på biblioteket her:
 
-**<https://statisticsnorway.github.io/metodebiblioteket/>**
+**<https://statisticsnorway.github.io/ssb-metodebiblioteket/>**
 
 ## Installasjon
 
 Repoen er organiserte som en R-pakke. For å installere det og alle
 avhengige metode pakke
 
 Du kan installere R-pakken metodebiblioteket fra
-[GitHub](https://github.com/statisticsnorway/metodebiblioteket/) ved:
+[GitHub](https://github.com/statisticsnorway/ssb-metodebiblioteket/) ved:
 
 ``` r
-renv::install("statisticsnorway/metodebiblioteket")
+renv::install("statisticsnorway/ssb-metodebiblioteket")
+```
+Dette trenger du å gjøre kun en gang. For å ta i bruk R funksjoner i Metodebiblioteket må du kalle inn pakken hver gang du starte en ny R sesjon med:
+```r
+library(metodebiblioteket)
 ```
 
 ## Nøkkelord

bidra.md

@@ -5,15 +5,17 @@ Her finner du veiledning om hvordan du kan bidra til Metodebiblioteket med en fu
 Clone repository fra [github](https://github.com/statisticsnorway/metodebiblioteket). Dette kan du gjøre fra terminalet eller fra inn i RStudio for eksempel. Lage en ny branch for endringer. 
 
 2. **Legg funksjonen inn i create_table.R**: 
-Åpne filen som ligger under "internal" som heter "create_table.R". Legg inn en ny rad med funksjonen "add_func()". Skriv navn av funksjonen, pakkenavn og stikkord. Standard stikkord som skal brukkes ligger på [Readme filen til repository](https://github.com/statisticsnorway/metodebiblioteket/blob/master/README.md#n%C3%B8kkelord). Skriv gjerne inn (GSBPM) prosessnummer i stikkord også. Kjør den nye raden du har skrevet slik at datafil som ligger bak oppdateres. 
+Åpne filen som ligger under "internal" som heter "create_table.R". Legg inn en ny rad med funksjonen "add_func()". Skriv navn av funksjonen, pakkenavn og stikkord. Standard stikkord som skal brukkes ligger på [Readme filen til repository](https://github.com/statisticsnorway/metodebiblioteket/blob/master/README.md#n%C3%B8kkelord). Skriv gjerne inn (GSBPM) prosessnummer i stikkord også. 
 
-3. **Legg pakken som brukes inn i DESCRIPTION fil**: 
-Hvis du har lagt inn en ny R funksjon skal pakken også ligge i DESCRIPTION filen under imports. Dette er for at Metodebiblioteket skal også fungere som en metapakke. Hvis pakken ligger der fra før er det ikke nødvendig å legge det inn på nytt.
+3. **Kjør add_func()**
+Kjør den nye raden du har skrevet som inkludere *add_func()*. Dette oppdatere datafil som ligger bak Metodebiblioteket.
 
+5. **Legg pakken som brukes inn i DESCRIPTION fil**: 
+Hvis du har lagt inn en ny R funksjon skal pakken også ligge i DESCRIPTION filen under imports. Dette er for at Metodebiblioteket skal også fungere som en metapakke. Hvis pakken ligger der fra før er det ikke nødvendig å legge det inn på nytt.
 
-4. **Skriv en enhetstest til funksjonen**: 
+6. **Skriv en enhetstest til funksjonen**: 
 For å forsikre kvalitet til funksjonene vi inkluderer i Metodebiblioteket har vi et mål at alle funksjoner skal har minst en enhetstest. Disse testene kjøres automatisk ved endring til hoved branch for å sjekke at funksjoner fungere som de skal. For mer informasjon om enhetstest skriving se [Hadley Wickhams veiledning til testthat](https://r-pkgs.org/testing-basics.html) for R eller [veiledning til pytest](https://docs.pytest.org/en/7.4.x/getting-started.html) for python. Enhetstester i R skal ligge under mappen tests > testthat. Python enhetstester skal ligge under python > tests. 
 
-5. **Commit og push endringer til github**:
+7. **Commit og push endringer til github**:
 Commit og push endringer til github. Alle endringer til create_table.R filen, data filen ("katalogdata.csv"), hjelpefiler (DESCRIPTION og reexports.R), og enhetstester skal inkluderes. Til slutt, lage en pull request for å merge branch inn til hovedbranch som da starter oppdatering av nettsiden automatisk.