나는 CRAN에 나의 첫 번째 패키지를 얻었고 당신도 할 수 있습니다.

첫 패키지를 CRAN에 성공적으로 제출한 지 거의 2주가 되었습니다 . runcharter의 패키지는 많은 이유에 대해 나에게 특별하다 – 그것은 힘들어 문제가 있었다, 그리고 내가 지난 몇 년 동안 다양한 도구에 근무했습니다 하나입니다. 이 패키지가 2012년에 존재했다면(그리고 당시 R이 무엇인지 알았다면) 직장 생활이 훨씬 쉬웠을 것입니다.

패키지는 몇 년 동안 github에서 먼지를 모으고 있습니다. 최근에 NHSRplothedots 패키지를 CRAN 에 성공적으로 제출한 NHS-R 동료들의 성공에 자극을 받아 (그들이 이에 대해 글을 쓰게 할 것입니다), 저는 그것을 실행하기로 결정하고 제 운을 시험해 보기로 했습니다.

패키지의 상태가 양호하다고 확신했습니다. 각 커밋에 대해 R CMD 검사를 실행하도록 GitHub 작업을 설정했습니다. 자신의 랩톱/PC에서 이러한 검사를 실행하는 것 외에도 이것의 이점은 검사가 개발 버전을 포함한 다양한 R 버전과 기본 운영 체제가 아닌 여러 운영 체제에서 실행된다는 것입니다. 패키지가 개발 버전에서 작동하지 않으면 CRAN에 도달하지 않습니다.

{usethis} 패키지를 통해 github 작업을 설정할 수 있습니다. 이 패키지는 패키지 개발의 장벽을 크게 낮췄습니다.

또한 단위 테스트를 설정해야 합니다. 대부분 {testthat}을 사용할 것입니다(비록 {checkmate}와 {tinytest}의 조합을 정말 좋아하지만).

테스트에서 다루어야 하는 정의된 비율의 코드가 있는지 확실하지 않습니다. CRAN에서 비교적 낮은 코드 적용 범위를 가진 큰 코드베이스를 가진 일부 패키지를 본 적이 있습니다. 높을수록 더 잘 얻을 수 있습니다. runcharter는 현재 94%, NHSRplotthedots 패키지는 100%, 광범위한 테스트 배터리로 주로 이런 종류의 물건에 절대적인 전문가인 @tomjemmet 덕분입니다.

이 두 단계 모두 패키지를 준비하는 데 큰 도움이 됩니다.

패키지 문서, README 및 pkgdown을 사용하는 패키지 웹 사이트와 같은 항목에 대해 설명하고 있습니다. 웹 사이트는 추가 옵션이지만 pkgdown을 사용하면 웹 사이트를 시작하고 실행하는 것이 매우 간단합니다. 당신은 아마 그것을 활용해야합니다.

비교적 사소한 세부 사항에 걸려 넘어질 가능성이 가장 큽니다.

다음은 확인 및/또는 생각해야 할 몇 가지 사항입니다.

설명 파일

제목은 제목 대소문자가 아닌 대소문자

사용해야 함

마지막 줄은 제목 케이스에 있습니다.

확실하지 않은 경우 이 제목 대소문자 변환기가 확인하는 데 도움이 됩니다.

실제 설명 부분은 짧은 단락(3~4문장 정도)이어야 하고 띄어쓰기/들여쓰기가 정확해야 합니다. 들여쓰기가 올바르지 않으면 패키지가 로컬로 빌드되지 않을 수도 있습니다. 그래서 제출한 날 밤까지 내 설명은 한 줄짜리였습니다. 나는 그럭저럭 살을 붙이고 올바르게 정렬된 상태를 유지했습니다(두 번째 줄부터 4칸 사용).

URL

내 설명 파일에 후행 ‘/’가 없는 URL이 있었습니다. 그래서 그것은 실패한 제출이었습니다.

URL이 ‘https://’가 아닌 ‘http://’를 가리키는 경우에도 문제가 됩니다. URL에 리디렉션이 있는 경우 문제가 있는 것입니다.

고맙게도 이러한 모든 문제에 도움이 되는 {urlchecker} 패키지가 있습니다.

지난 몇 달 동안 찾은 몇 가지 링크와 가이드가 포함된 파일을 여기에 설정했습니다.

https://github.com/johnmackintosh/CRANt-touch-this

더 좋은 것이 있거나 아직 다루지 못한 걸림돌이 있다면 PR을 올려주세요.

이것이 다른 누군가가 자신의 패키지를 CRAN에 가져오는 데 도움이 되기를 바랍니다.

Leave a Comment