Skip to content

Commit

Permalink
tried to add @éxamples
Browse files Browse the repository at this point in the history
  • Loading branch information
FrLars21 committed Sep 2, 2024
1 parent a2d54ef commit e3a69e3
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 3 deletions.
2 changes: 2 additions & 0 deletions R/noegletal_get.R
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ noegletal_wrangle <- function(df) {
#' @param variable_ids Vector of variable IDs
#' @returns Tidy [tibble::tibble()] with requested data
#' @export
#' @examples
#' noegletal_get(muni_codes = c(101, 155), years = 2018:2024, variable_ids = c(001))
noegletal_get <- function(muni_codes = ALLOWED_MUNI_CODES,
years = ALLOWED_YEARS,
variable_ids) {
Expand Down
4 changes: 4 additions & 0 deletions R/noegletal_tidy.R
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
#' and one column for each included variable (nøgletal).
#'
#' @export
#' @examples
#' \dontrun{
#' noegletal_tidy(file = 'path/to/csv_file.csv')
#' }
noegletal_tidy <- function(file) {

if (!file.exists(file)) {
Expand Down
2 changes: 2 additions & 0 deletions R/noegletal_vars.R
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
#' @returns A [tibble::tibble()] where each row is a variable and the columns are
#' 'variable_id', 'variable_name' and 'variable_definition'.
#' @export
#' @examples
#' noegletal_vars()
noegletal_vars <- function() {

source_code <- rvest::read_html("https://www.noegletal.dk/noegletal/ntInfo24A.html",
Expand Down
10 changes: 9 additions & 1 deletion man/noegletalR-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion man/noegletal_get.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions man/noegletal_tidy.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion man/noegletal_vars.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit e3a69e3

Please # to comment.