Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add usethis:: like functions to allow data package construction interactively #44

Closed
gfinak opened this issue Aug 8, 2018 · 0 comments
Assignees

Comments

@gfinak
Copy link
Member

gfinak commented Aug 8, 2018

At the request of @raphg datapackage_skeleton() should be allowed to create
and empty skeleton directory.

  • usethis::-like functions could be implemented to add data sets and processing scripts interactively.

Proposal:

  • use_script

    • would take an R or Rmd file path.
    • copy the file into the skeleton
    • update the yaml
    • We could consider some way of tagging objects or code chunks or lines of code in the Rmd or R file
      to automatically extract names of data objects to add to the yaml config.
  • use_data_object

    • would take a data object argument
    • would add the data_object to the yaml config.
  • use_raw_dataset

    • would take a path to a directory or a specific file
    • would copy the directory or file into inst/extdata

Tagging data objects in code

  • custom Rd like tag as comment followed by the name of the object:
#' @dataobject name
  • need to write a parser?

Need to assess how this will interact with roxygen.. maybe not at all since we are parsing roxygen from documentation.R.

@gfinak gfinak self-assigned this Aug 8, 2018
gfinak added a commit that referenced this issue Aug 17, 2018
Version 0.15.2
add use_raw_dataset #44
update NEWS
fix CRAN link in README
update cran_comments
styling and goodpractice
update codemeta.json
gfinak added a commit that referenced this issue Aug 22, 2018
@gfinak gfinak closed this as completed in 54206f2 Aug 22, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant