From 49637145d2848c628dc0a4a0b27ababd927932bc Mon Sep 17 00:00:00 2001 From: Susie Jentoft Date: Tue, 16 Apr 2024 10:28:08 +0200 Subject: [PATCH 1/5] Update bidra.md Specified that add_func needs to be run. --- bidra.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/bidra.md b/bidra.md index 3bbf21a..73e0dab 100644 --- a/bidra.md +++ b/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. From 0218f75351d5e659447c89e62a803bde58a380aa Mon Sep 17 00:00:00 2001 From: Susie Jentoft Date: Tue, 28 May 2024 09:36:46 +0200 Subject: [PATCH 2/5] Name change --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e276ff4..fa7763a 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # 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: -**** +**** ## Installasjon @@ -15,10 +15,14 @@ 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 From 7b0bd33e2251f9e58e1fd26f95e8646bf6479179 Mon Sep 17 00:00:00 2001 From: Susie Jentoft Date: Tue, 28 May 2024 10:00:05 +0200 Subject: [PATCH 3/5] Update R-CMD-check.yaml --- .github/workflows/R-CMD-check.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml index 7629aa6..4e3b4dc 100644 --- a/.github/workflows/R-CMD-check.yaml +++ b/.github/workflows/R-CMD-check.yaml @@ -30,7 +30,7 @@ jobs: R_KEEP_PKG_SOURCE: yes steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: r-lib/actions/setup-pandoc@v2 From 27b0561f3ce96391022aa332cf7bfdaf742c4264 Mon Sep 17 00:00:00 2001 From: Susie Date: Tue, 28 May 2024 10:29:41 +0200 Subject: [PATCH 4/5] Added newest version back in, update of checkout. --- .github/workflows/R-CMD-check.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml index 7629aa6..243c0a5 100644 --- a/.github/workflows/R-CMD-check.yaml +++ b/.github/workflows/R-CMD-check.yaml @@ -20,7 +20,7 @@ jobs: matrix: config: #- {os: windows-latest, r: 'release'} - #- {os: ubuntu-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'} @@ -30,7 +30,7 @@ jobs: 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::., any::simputation needs: check - name: Session info From f1632dd62babc3c48c5641288bc6bdac8315dd88 Mon Sep 17 00:00:00 2001 From: Susie Date: Tue, 28 May 2024 10:44:29 +0200 Subject: [PATCH 5/5] Just testing now on new version of R. --- .github/workflows/R-CMD-check.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml index 243c0a5..149a1d4 100644 --- a/.github/workflows/R-CMD-check.yaml +++ b/.github/workflows/R-CMD-check.yaml @@ -19,11 +19,11 @@ jobs: fail-fast: false matrix: config: - #- {os: windows-latest, r: 'release'} + - {os: windows-latest, r: 'release'} - {os: ubuntu-latest, r: 'release'} - - {os: ubuntu-latest, r: '4.2.3'} + #- {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 }} @@ -42,7 +42,7 @@ jobs: - uses: r-lib/actions/setup-r-dependencies@v2 with: - extra-packages: any::sessioninfo, any::rcmdcheck, local::., any::simputation + extra-packages: any::sessioninfo, any::rcmdcheck, local::. needs: check - name: Session info