search

ropensci / neotoma

Programmatic R interface to the Neotoma Paleoecological Database.
https://docs.ropensci.org/neotoma
Other
30 stars 16 forks source link

Neotoma uses it's own keywords, not those on the approved list #124

Closed gavinsimpson closed 9 years ago

gavinsimpson commented 10 years ago

The \keyword{} macro is supposed to only take keywords specified in the KEYWORDS file in the R sources. neotoma is using it's own keywords. Hence these need editing to be from the approved list, appended below:

GROUPED Keywords
----------------

Graphics
    aplot       &   Add to Existing Plot / internal plot
    dplot       &   Computations Related to Plotting
    hplot       &   High-Level Plots
    iplot       &   Interacting with Plots
    color       &   Color, Palettes etc
    dynamic     &   Dynamic Graphics
    device      &   Graphical Devices

Basics
    sysdata     &   Basic System Variables      [!= S]
    datasets    &   Datasets available by data(.)   [!= S]
    data        &   Environments, Scoping, Packages [~= S]
    manip       &   Data Manipulation
    attribute   &   Data Attributes
    classes     &   Data Types (not OO)
        & character &   Character Data ("String") Operations
        & complex   &   Complex Numbers
        & category  &   Categorical Data
        & NA    &   Missing Values          [!= S]
    list        &   Lists
    chron       &   Dates and Times
    package     &   Package Summaries

Mathematics
    array       &   Matrices and Arrays
          & algebra &   Linear Algebra
    arith       &   Basic Arithmetic and Sorting    [!= S]
    math        &   Mathematical Calculus etc.  [!= S]
    logic       &   Logical Operators
    optimize    &   Optimization
    symbolmath  &   "Symbolic Math", as polynomials, fractions
    graphs      &   Graphs, (not graphics), e.g. dendrograms

Programming, Input/Ouput, and Miscellaneous

    programming &   Programming
         & interface&   Interfaces to Other Languages
    IO      &   Input/output
         & file &   Files
         & connection&  Connections
         & database &   Interfaces to databases
    iteration   &   Looping and Iteration
    methods     &   Methods and Generic Functions
    print       &   Printing
    error       &   Error Handling

    environment &   Session Environment
    internal    &   Internal Objects (not part of API)
    utilities   &   Utilities
    misc        &   Miscellaneous
    documentation   &   Documentation
    debugging   &   Debugging Tools

Statistics

    datagen     &   Functions for generating data sets
    distribution    &   Probability Distributions and Random Numbers
    univar      &   simple univariate statistics  [!= S]
    htest       &   Statistical Inference
    models      &   Statistical Models
        & regression&   Regression
        & &nonlinear&   Non-linear Regression (only?)
    robust      &   Robust/Resistant Techniques
    design      &   Designed Experiments
    multivariate    &   Multivariate Techniques
    ts      &   Time Series
    survival    &   Survival Analysis
    nonparametric   &   Nonparametric Statistics [w/o 'smooth']
    smooth      &   Curve (and Surface) Smoothing
         & loess    &   Loess Objects
    cluster     &   Clustering
    tree        &   Regression and Classification Trees
    survey      &   Complex survey samples

MASS (2, 1997)
--------------

add the following keywords :

    classif     &   Classification  ['class' package]
    spatial     &   Spatial Statistics ['spatial' package]
    neural      &   Neural Networks ['nnet'  package]
SimonGoring commented 9 years ago

@gavinsimpson does 5d60983 do what you were thinking? I felt like the keyword list was pretty limited for this application, but wanted to get started on it.

gavinsimpson commented 9 years ago

Yup @SimonGoring that's along the lines I was thinking. The keywords are only used to group functions/concepts in the manual index for the package. I would probably not have a function under both internal and misc as the former indicates functions internal to the package, which we probably don't/shouldn't export.

SimonGoring commented 9 years ago

Okay, got it.

On Wed, Sep 17, 2014 at 3:12 PM, Gavin Simpson notifications@github.com wrote:

Yup @SimonGoring https://github.com/SimonGoring that's along the lines I was thinking. The keywords are only used to group functions/concepts in the manual index for the package. I would probably not have a function under both internal and misc as the former indicates functions internal to the package, which we probably don't/shouldn't export.

— Reply to this email directly or view it on GitHub https://github.com/ropensci/neotoma/issues/124#issuecomment-55952553.

SimonGoring commented 9 years ago

This seems to be cleared up. I'm going to mark it as closed.