almartin82 / mapvizieR

visualizations and reports for the NWEA MAP assessment in R
Other
17 stars 6 forks source link

documentation cleanup #286

Open almartin82 opened 8 years ago

almartin82 commented 8 years ago

cmd-check is failing - some mistakes in function docs that need to be tidied up:

* checking Rd \usage sections ... WARNING
Undocumented arguments in documentation object 'adhoc_psuedo_quartile'
  'x'
Documented arguments not in \usage in documentation object 'adhoc_psuedo_quartile':
  'vector'

Undocumented arguments in documentation object 'becca_plot'
  'quartile_type'

Undocumented arguments in documentation object 'cohort_status_trace_plot'
  'small_n_cutoff'
Duplicated \argument entries in documentation object 'cohort_status_trace_plot':
  'mapvizieR_obj' 'studentids' 'measurementscale' 'match_method'
  'first_and_spring_only' 'entry_grade_seasons' 'collapse_schools'
  'plot_labels'

Documented arguments not in \usage in documentation object 'mapvizieR':
  'norms'

Duplicated \argument entries in documentation object 'summary.mapvizieR':
  'object' '...' 'object' 'object' '...'
almartin82 commented 8 years ago

also these:

Argument items with no description in Rd object 'cdf_collapse_by_grade':
  'cdf'

Argument items with no description in Rd object 'cohort_status_trace_plot':
  'retention_strategy' 'mapvizieR_obj' 'studentids' 'measurementscale'
  'match_method' 'first_and_spring_only' 'entry_grade_seasons'
  'collapse_schools' 'plot_labels'

Argument items with no description in Rd object 'summary.mapvizieR':
  'object'