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

Enable interactive project set-up #121

Closed
MiguelRodo opened this issue Aug 31, 2022 · 9 comments
Closed

Enable interactive project set-up #121

MiguelRodo opened this issue Aug 31, 2022 · 9 comments
Labels
init Concerns projr_init next Next issue to work on v1.0.0 Part of first major release

Comments

@MiguelRodo
Copy link
Collaborator

  • Prompt user for inputs/option selection
    • If an option is not done, then add it to DELETE-AFTER-DOING.md.
@MiguelRodo MiguelRodo added v1.0.0 Part of first major release init Concerns projr_init next Next issue to work on labels Oct 7, 2022
@MiguelRodo MiguelRodo pinned this issue Oct 13, 2022
@MiguelRodo
Copy link
Collaborator Author

MiguelRodo commented Oct 20, 2022

Okay, so, what are the components of this?

  • Looking at DELETE-AFTER-DOING.md:
    • Ask for the name, and then
      • Put it into the following places:
        • _bookdown.yml:
          • book_filename: <name>
          • output_dir: docs/<name>V-<version>
        • _output.yml:
          • In line 9, in <li><a href="https://github.com/SATVIlab/TODO:_ADD_REPO_NAME" target="blank">SATVIlab/<name></a></li>
        • DESCRIPTION
          • In line 1, change it to Package: <name>
        • README.md
          • In lin 1, changed it to # `
        • In index.Rmd, change line 2 to title: "<name>"
    • Ask for the GitHub user:
      • In line 9, change to the GitHub user: In line 9, in
      • /
      • `
    • Ask for a short description
      • In line 7 of _output.yml, replace TODO: ADD SHORT DESCRIPTION with a short project description
    • Ask for a longer description, or re-use shorter one
      • Add it to:
        • Line 9 of DESCRIPTION
        • description: of `index.Rmd

@MiguelRodo
Copy link
Collaborator Author

Okay, so how to read stuff in?

  • Well, DataPackageR simply prompts with cat and then reads in using readlines(prompt = '+ ')

@MiguelRodo
Copy link
Collaborator Author

MiguelRodo commented Oct 20, 2022

Looking at issue 230 of DataPackageR for the DataPackageR ropensci review, I see that interactivity should be able to be turned off for the sake of tests not simply through interactive() being FALSE as otherwise it makes the testing stop-start when using an interactive session.

@MiguelRodo
Copy link
Collaborator Author

So, this process should clarify what should still be in DELETE-AFTER-DOING.md.

@MiguelRodo
Copy link
Collaborator Author

MiguelRodo commented Oct 21, 2022

I also need to make sure we fill in more of DESCRIPTION:

Package: DataTidyACSAll
Title: {{ Title }}
Version: 1.0.0
Authors@R: 
    c(person(given = "Jo", family = "Doe", email = "jodoe@dom.ain",
      role = c("aut", "cre")))
Maintainer: {{ Maintainer }}
Description: {{ Description }}
License: {{ License }}
URL: {{ URL }}
BugReports: {{ BugReports }}
Encoding: UTF-8

I must also check that we have all the bits we need.

@MiguelRodo
Copy link
Collaborator Author

Okay, so I've done almost everything, including even creating the Git repo and the GitHub remote (thanks to usethis).

I need to make the README a bit better, I think. It'll be very convenient for later projr functionality to add that in.

@MiguelRodo
Copy link
Collaborator Author

I think the README is now done. Pending final testing, I think we have our man!

@MiguelRodo
Copy link
Collaborator Author

Next steps:

  • Delete the lines you're supposed to delete from the README text

@MiguelRodo
Copy link
Collaborator Author

I'd say this is done! Whoohoo!

@MiguelRodo MiguelRodo unpinned this issue Oct 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
init Concerns projr_init next Next issue to work on v1.0.0 Part of first major release
Projects
None yet
Development

No branches or pull requests

1 participant