search

rOpenGov / sweidnumbr

R package for Structural handling of identity numbers used in the swedish administration such as personal identity numbers (personnummer) and organizational identity numbers (organisationsnummer).
https://ropengov.github.io/sweidnumbr/
Other
8 stars 3 forks source link

Go through which functions to hide from API #83

Closed MansMeg closed 8 years ago

MansMeg commented 8 years ago

Now a large amount of functions is exported, even internal functions such as oin_group_element, pin_birthplace_internal, pin_coordn_correct and pin_century is now exported.

The api should also be added as a test in the test suite.

eribul commented 8 years ago

Hmm, are you sure? I don't actually see those functions in the NAMESPACE (or any@export statements in their Roxygen-comments). Or am I missing something?

MansMeg commented 8 years ago

Hmmm... Nej det verkar inte vara en del av API:et. Det är dock en del av dokumentationen så jag tolkade det som att de var exporterade till NAMESPACE. Detta är inte längre ngt problem. =)

eribul commented 8 years ago

Hehe jo, lite knepigt kanske. Men man kan t ex också låta bli att indexera just de hjälptexterna enligt citat nedan från: https://cran.r-project.org/web/packages/roxygen2/vignettes/rd.html (dvs man kan hitta dem om man vet att hjälpfunktionerna finns, t ex om man själv läser källkoden men man hittar dem inte via help(package = "sweidnumbr")). Alternativt kan vi ju skippa dokumentationen också, tex byta ut #' mot bara # om vi ändå vill behålla det strukturerade formatet men bara som en del av källkoden för vår egen skull?

@keywords keyword1 keyword2 ... to add standardised keywords. Keywords are optional, but if present, must be taken from the predefined list replicated in the keywords vignette. Keywords are not very useful, except for @keywords internal. Using the internal keyword removes all functions in the associated .Rd file from the documentation index and disables some of their automated tests. A common use case is to both export a function (using @export) and marking it as internal. That way, advanced users can access a function that new users would be confused about if they were to see it in the index.

MansMeg commented 8 years ago

Det låter vettigt att använda @keyword internal som lösning på problemet. Då kan man se till att dokumentationen inte indexeras men går att kolla på för mer avancerade användare och oss.

Lägger upp detta som en separat issue!