Skip to contents

With the given API token, will retrieve a list of all the forms you have access to

Usage

ns_get_codebook(form_id, asis = FALSE)

Arguments

form_id

integer. Number of the form to retrieve

asis

logical. Whether to return the raw content from nettskjema. Default is FALSE.

Value

list of class ns_meta_data

Examples

ns_get_codebook(123823)
#>    element_no    element_type                element_code
#> 1           1         HEADING                        <NA>
#> 2           2            TEXT                        <NA>
#> 3           3           IMAGE                        <NA>
#> 4           4      PAGE_BREAK                        <NA>
#> 5           5        QUESTION                    freetext
#> 6           6           RADIO                       radio
#> 7           6           RADIO                       radio
#> 8           7        CHECKBOX     checkbox.questionnaires
#> 9           7        CHECKBOX             checkbox.events
#> 10          7        CHECKBOX               checkbox.logs
#> 11          8          SELECT                    dropdown
#> 12          8          SELECT                    dropdown
#> 13          9    MATRIX_RADIO         radio_matrix.grants
#> 14          9    MATRIX_RADIO         radio_matrix.grants
#> 15          9    MATRIX_RADIO         radio_matrix.grants
#> 16          9    MATRIX_RADIO        radio_matrix.lecture
#> 17          9    MATRIX_RADIO        radio_matrix.lecture
#> 18          9    MATRIX_RADIO        radio_matrix.lecture
#> 19          9    MATRIX_RADIO          radio_matrix.email
#> 20          9    MATRIX_RADIO          radio_matrix.email
#> 21          9    MATRIX_RADIO          radio_matrix.email
#> 22         10 MATRIX_CHECKBOX        checkbox_matrix.1.IT
#> 23         10 MATRIX_CHECKBOX checkbox_matrix.1.colleague
#> 24         10 MATRIX_CHECKBOX     checkbox_matrix.1.admin
#> 25         10 MATRIX_CHECKBOX     checkbox_matrix.1.union
#> 26         10 MATRIX_CHECKBOX  checkbox_matrix.1.internet
#> 27         10 MATRIX_CHECKBOX        checkbox_matrix.2.IT
#> 28         10 MATRIX_CHECKBOX checkbox_matrix.2.colleague
#> 29         10 MATRIX_CHECKBOX     checkbox_matrix.2.admin
#> 30         10 MATRIX_CHECKBOX     checkbox_matrix.2.union
#> 31         10 MATRIX_CHECKBOX  checkbox_matrix.2.internet
#> 32         11            DATE                        date
#> 33         12            DATE                        time
#> 34         13            DATE                    datetime
#> 35         14          NUMBER              number_decimal
#> 36         15          NUMBER              number_integer
#> 37         16    LINEAR_SCALE                      slider
#> 38         17      ATTACHMENT                attachment_1
#> 39         18      ATTACHMENT                attachment_2
#>                                                                               element_text
#> 1                                         Let talk about Nettskjema! This is a subheading!
#> 2                                                                                     <NA>
#> 3                                                                                     <NA>
#> 4                                                                                     <NA>
#> 5  This is a question about something super important, where the user can input free text.
#> 6                                                        How happy are we with Nettskjema?
#> 7                                                        How happy are we with Nettskjema?
#> 8                                                  What do we use it for?:: Questionnaires
#> 9                                                  What do we use it for?:: Event sign-ups
#> 10                                                   What do we use it for?:: Data logging
#> 11                                                     Who is responsible with Nettskjema?
#> 12                                                     Who is responsible with Nettskjema?
#> 13                               In the last month I have: written some grant applications
#> 14                               In the last month I have: written some grant applications
#> 15                               In the last month I have: written some grant applications
#> 16                                                In the last month I have: held a lecture
#> 17                                                In the last month I have: held a lecture
#> 18                                                In the last month I have: held a lecture
#> 19                                             In the last month I have: sent some e-mails
#> 20                                             In the last month I have: sent some e-mails
#> 21                                             In the last month I have: sent some e-mails
#> 22                                      In the last year, I have :: sought help from :: IT
#> 23                             In the last year, I have :: sought help from :: A colleague
#> 24                          In the last year, I have :: sought help from :: Administration
#> 25                                   In the last year, I have :: sought help from :: Union
#> 26                                In the last year, I have :: sought help from :: Internet
#> 27                                 In the last year, I have :: received e-mails from :: IT
#> 28                        In the last year, I have :: received e-mails from :: A colleague
#> 29                     In the last year, I have :: received e-mails from :: Administration
#> 30                              In the last year, I have :: received e-mails from :: Union
#> 31                           In the last year, I have :: received e-mails from :: Internet
#> 32                                                                    Choose a random date
#> 33                                                               now choose a random time!
#> 34                                                          Lastly choose a date AND time!
#> 35                                                         Pick a number between 0 and 10!
#> 36                                                     Choose an integer between 0 and 100
#> 37                                                           Choose a point on the slider!
#> 38                                                                     Upload a fun image!
#> 39                                                                  This is an attachment2
#>                                                                                  element_desc
#> 1                                                                                        <NA>
#> 2  <p>This is some text in the form, not a question but a descriptive text.</p>\n\n<p> </p>\n
#> 3                                                                                        <NA>
#> 4                                                                                        <NA>
#> 5    <p>With a description field giving details on what should be answered.</p>\n\n<p> </p>\n
#> 6                                 <p>This is a question with radio buttons.</p>\n\n<p> </p>\n
#> 7                                 <p>This is a question with radio buttons.</p>\n\n<p> </p>\n
#> 8         <p>This is a checkbox question, where respondents can choose several options.</p>\n
#> 9         <p>This is a checkbox question, where respondents can choose several options.</p>\n
#> 10        <p>This is a checkbox question, where respondents can choose several options.</p>\n
#> 11                                               <p>This is a dropdown list</p>\n\n<p> </p>\n
#> 12                                               <p>This is a dropdown list</p>\n\n<p> </p>\n
#> 13                                                                                       <NA>
#> 14                                                                                       <NA>
#> 15                                                                                       <NA>
#> 16                                                                                       <NA>
#> 17                                                                                       <NA>
#> 18                                                                                       <NA>
#> 19                                                                                       <NA>
#> 20                                                                                       <NA>
#> 21                                                                                       <NA>
#> 22                                                                                       <NA>
#> 23                                                                                       <NA>
#> 24                                                                                       <NA>
#> 25                                                                                       <NA>
#> 26                                                                                       <NA>
#> 27                                                                                       <NA>
#> 28                                                                                       <NA>
#> 29                                                                                       <NA>
#> 30                                                                                       <NA>
#> 31                                                                                       <NA>
#> 32                                                    <p>Choose whatever date you want!</p>\n
#> 33                                                                     <p> </p>\n\n<p> </p>\n
#> 34                                                                     <p> </p>\n\n<p> </p>\n
#> 35                                                       <p>with description</p>\n\n<p></p>\n
#> 36                                                          <p>as an integer</p>\n\n<p></p>\n
#> 37                                                                                       <NA>
#> 38                                                                     <p> </p>\n\n<p> </p>\n
#> 39                                                       <p>with description</p>\n\n<p></p>\n
#>    subelement_seq    answer_text    answer_code answer_seq
#> 1              NA           <NA>           <NA>         NA
#> 2              NA           <NA>           <NA>         NA
#> 3              NA           <NA>           <NA>         NA
#> 4              NA           <NA>           <NA>         NA
#> 5              NA           <NA>           <NA>         NA
#> 6              NA    Very happy!              1          1
#> 7              NA  Very unhappy!             -1          2
#> 8              NA Questionnaires questionnaires          1
#> 9              NA Event sign-ups         events          2
#> 10             NA   Data logging           logs          3
#> 11             NA            UiO              4          1
#> 12             NA        OsloMet              9          2
#> 13              1            yes              1          1
#> 14              1             no              2          2
#> 15              1 not applicable              3          3
#> 16              2            yes              1          1
#> 17              2             no              2          2
#> 18              2 not applicable              3          3
#> 19              3            yes              1          1
#> 20              3             no              2          2
#> 21              3 not applicable              3          3
#> 22              1             IT             IT          1
#> 23              1    A colleague      colleague          2
#> 24              1 Administration          admin          3
#> 25              1          Union          union          4
#> 26              1       Internet       internet          5
#> 27              2             IT             IT          1
#> 28              2    A colleague      colleague          2
#> 29              2 Administration          admin          3
#> 30              2          Union          union          4
#> 31              2       Internet       internet          5
#> 32             NA           <NA>           <NA>         NA
#> 33             NA           <NA>           <NA>         NA
#> 34             NA           <NA>           <NA>         NA
#> 35             NA           <NA>           <NA>         NA
#> 36             NA           <NA>           <NA>         NA
#> 37             NA           <NA>           <NA>         NA
#> 38             NA           <NA>           <NA>         NA
#> 39             NA           <NA>           <NA>         NA
ns_get_codebook(123823, asis = TRUE)
#>  [1] "HEADING"         "TEXT"            "IMAGE"           "PAGE_BREAK"     
#>  [5] "QUESTION"        "RADIO"           "CHECKBOX"        "SELECT"         
#>  [9] "MATRIX_RADIO"    "MATRIX_CHECKBOX" "DATE"            "DATE"           
#> [13] "DATE"            "NUMBER"          "NUMBER"          "LINEAR_SCALE"   
#> [17] "ATTACHMENT"      "ATTACHMENT"     
#> # Nettskjema raw codebook for form 123823
#> 
#> no. elements: 18
#> HEADING
#> TEXT
#> IMAGE
#> PAGE_BREAK
#> QUESTION
#> RADIO
#> CHECKBOX
#> SELECT
#> MATRIX_RADIO
#> MATRIX_CHECKBOX
#> DATE
#> DATE
#> DATE
#> NUMBER
#> NUMBER
#> LINEAR_SCALE
#> ATTACHMENT
#> ATTACHMENT