CancerRegistryOfNorway / nordcansurvival

Other
0 stars 0 forks source link

Documentation issues #10

Closed WetRobot closed 3 years ago

WetRobot commented 3 years ago

This issue is pretty low-priority.

R CMD CHECK reported these problems with docs:

> checking Rd files ... NOTE
  prepare_Rd: extract_define_survival_data.Rd:16-18: Dropping empty section \value
  prepare_Rd: get_stata_info.Rd:12-14: Dropping empty section \value
  prepare_Rd: survival_statistics.Rd:23-25: Dropping empty section \value

> checking Rd line widths ... NOTE
  Rd file 'survival_statistics.Rd':
    \examples lines wider than 100 characters:
       infile <-  paste0(system.file(package = "nordcansurvival"), "/Stata/demo/NCS_NO_anonymous_example_data.dta")

  These lines will be truncated in the PDF manual.

The "\value" problem refers to empty sections defined under the roxygen command @return. See https://r-pkgs.org/man.html#man-functions.

HuidongTian commented 3 years ago

closes #10